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
200

List of teams retrieved successfully

application/json
get
/memberships/orgs/{organisationId}/teams
GET /memberships/orgs/{organisationId}/teams HTTP/1.1
Host: api.example.com
Accept: */*

{
  "data": [
    {
      "id": "team123-def6-7890-abcd-ef1234567890",
      "name": "Engineering Team",
      "description": "Core development team",
      "organisationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z",
      "memberCount": 5,
      "metadata": {
        "department": "Engineering",
        "budget": 50000
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}

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
201

Team created successfully

application/json
post
/memberships/orgs/{organisationId}/teams
POST /memberships/orgs/{organisationId}/teams HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "name": "Engineering Team",
  "description": "Core development team",
  "metadata": {
    "department": "Engineering",
    "budget": 50000
  }
}
{
  "id": "team123-def6-7890-abcd-ef1234567890",
  "name": "Engineering Team",
  "description": "Core development team",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "memberCount": 0,
  "metadata": {
    "department": "Engineering",
    "budget": 50000
  }
}

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
200

Team information retrieved successfully

application/json
get
/memberships/orgs/{organisationId}/teams/{teamId}
GET /memberships/orgs/{organisationId}/teams/{teamId} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "id": "team123-def6-7890-abcd-ef1234567890",
  "name": "Engineering Team",
  "description": "Core development team",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:45:00Z",
  "memberCount": 5,
  "metadata": {
    "department": "Engineering",
    "budget": 50000
  }
}

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
200

Team updated successfully

application/json
put
/memberships/orgs/{organisationId}/teams/{teamId}
PUT /memberships/orgs/{organisationId}/teams/{teamId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "name": "Senior Engineering Team",
  "description": "Senior development team with expanded responsibilities",
  "metadata": {
    "department": "Engineering",
    "budget": 75000
  }
}
{
  "id": "team123-def6-7890-abcd-ef1234567890",
  "name": "Senior Engineering Team",
  "description": "Senior development team with expanded responsibilities",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-22T16:30:00Z",
  "memberCount": 5,
  "metadata": {
    "department": "Engineering",
    "budget": 75000
  }
}

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
200

Team deleted successfully

application/json
delete
/memberships/orgs/{organisationId}/teams/{teamId}
DELETE /memberships/orgs/{organisationId}/teams/{teamId} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "success": true,
  "message": "Team successfully deleted"
}
PreviousOrganization UsersNextTeam Members