The Open API specification for Synapse is now available for download!

Download Open API Spec



JSON schema for Team POJO

Field Type Description
id STRING The id of the Team.
name STRING The name of the Team.
description STRING A short description of this Team.
icon STRING fileHandleId for icon image of the Team
canPublicJoin BOOLEAN true for teams which members can join without an invitation or approval. When this is true, canRequestMembership must be false or empty.
canRequestMembership BOOLEAN true for teams where users can create a membership request to join. When this is true, canPublicJoin must be false or empty.
etag STRING Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time a Team is updated it is used to detect when a client's current representation of a Team is out-of-date.
createdOn STRING The date this Team was created.
modifiedOn STRING The date this Team was last modified.
createdBy STRING The ID of the user that created this Team.
modifiedBy STRING The ID of the user that last modified this Team.