Organization Teams

List teams of an organization

get
/memberships/orgs/{organisationId}/teams

Gets the list of all teams that belong to the specified organization

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
Query parameters
pageinteger · min: 1Optional

Page number for pagination

Default: 1Example: 1
limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20Example: 20
Responses
chevron-right
200

List of teams retrieved successfully

application/json
get
/memberships/orgs/{organisationId}/teams

Create a new team

post
/memberships/orgs/{organisationId}/teams

Creates a new team in the specified organization

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
Body
namestring · max: 100Required

Name of the team

Example: Engineering Team
descriptionstring · max: 500Optional

Description of the team

Example: Core development team
Responses
post
/memberships/orgs/{organisationId}/teams

Get team information

get
/memberships/orgs/{organisationId}/teams/{teamId}

Gets the information of a specific team in the organization

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
teamIdstring · uuidRequired

Unique ID of the team

Example: team123-def6-7890-abcd-ef1234567890
Responses
chevron-right
200

Team information retrieved successfully

application/json
idstring · uuidOptional

Unique team ID

Example: team123-def6-7890-abcd-ef1234567890
namestringOptional

Name of the team

Example: Engineering Team
descriptionstringOptional

Description of the team

Example: Core development team
organisationIdstring · uuidOptional

ID of the organization this team belongs to (if team belongs to organization)

Example: 123e4567-e89b-12d3-a456-426614174000
collectiveIdstring · uuidOptional

ID of the collective this team belongs to (if team belongs to collective)

Example: collective123-def6-7890-abcd-ef1234567890
memberCountintegerOptional

Number of members in the team

Example: 5
createdAtstring · date-timeOptional

Date and time when the team was created

Example: 2024-01-15T10:30:00Z
updatedAtstring · date-timeOptional

Date and time of last update

Example: 2024-01-20T14:45:00Z
get
/memberships/orgs/{organisationId}/teams/{teamId}

Update team information

put
/memberships/orgs/{organisationId}/teams/{teamId}

Updates the information of a specific team in the organization

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
teamIdstring · uuidRequired

Unique ID of the team

Example: team123-def6-7890-abcd-ef1234567890
Body
namestring · max: 100Optional

New name for the team

Example: Senior Engineering Team
descriptionstring · max: 500Optional

New description for the team

Example: Senior development team with expanded responsibilities
Responses
chevron-right
200

Team updated successfully

application/json
idstring · uuidOptional

Unique team ID

Example: team123-def6-7890-abcd-ef1234567890
namestringOptional

Name of the team

Example: Engineering Team
descriptionstringOptional

Description of the team

Example: Core development team
organisationIdstring · uuidOptional

ID of the organization this team belongs to (if team belongs to organization)

Example: 123e4567-e89b-12d3-a456-426614174000
collectiveIdstring · uuidOptional

ID of the collective this team belongs to (if team belongs to collective)

Example: collective123-def6-7890-abcd-ef1234567890
memberCountintegerOptional

Number of members in the team

Example: 5
createdAtstring · date-timeOptional

Date and time when the team was created

Example: 2024-01-15T10:30:00Z
updatedAtstring · date-timeOptional

Date and time of last update

Example: 2024-01-20T14:45:00Z
put
/memberships/orgs/{organisationId}/teams/{teamId}

Delete a team

delete
/memberships/orgs/{organisationId}/teams/{teamId}

Deletes a specific team from the organization

Path parameters
organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
teamIdstring · uuidRequired

Unique ID of the team to delete

Example: team123-def6-7890-abcd-ef1234567890
Responses
chevron-right
200

Team deleted successfully

application/json
successbooleanRequired

Indicates if the operation was successful

Example: true
messagestringRequired

Descriptive success message

Example: Operation completed successfully
delete
/memberships/orgs/{organisationId}/teams/{teamId}

Last updated