Teams

Last updated 24 days ago

Teams

Base path: /v1/teams · Auth: Bearer

MethodPathPurpose
GET/v1/teamsList teams
POST/v1/teamsCreate a team
GET/v1/teams/{teamId}Get a team
PATCH/v1/teams/{teamId}Update a team
DELETE/v1/teams/{teamId}Delete a team
POST/v1/teams/{teamId}/membersAdd members
DELETE/v1/teams/{teamId}/members/{userId}Remove a member

Query (GET /v1/teams)

Pagination plus status (active/inactive/deleted) and parent (UUID).

Body — create (POST /v1/teams)

FieldTypeRequiredDescription
namestring (1–255)Team name
parentUUIDParent team
initialsstring (≤10)Short label
avatarstring (URI)Avatar URL
sidstringCustom short ID

Body — update (PATCH /v1/teams/{teamId})

All optional: name, parent, status (active/inactive/deleted), initials, avatar.

Body — add members (POST /v1/teams/{teamId}/members)

FieldTypeRequiredDescription
membersUUID[] (min. 1)Users to add

Example

bash