Teams

Last updated 1 year ago

Was this helpful?

List teams

List the teams inside an organization.

get

/organizations/{organizationId}/teams

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

reverseboolean

Order in which to retrieve the results

pageTokenstring

Pagination token that keeps of track of the current position in the list

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/teams' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "activeMemberCount": 1,
      "pendingMemberCount": 1,
      "createdAt": "2025-02-21T18:08:53.831Z",
      "updatedAt": "2025-02-21T18:08:53.831Z",
      "visibility": "public",
      "accessibility": "open",
      "featuredMembers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "user"
        }
      ],
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create team

Create a new team inside the organization.

post

/organizations/{organizationId}/teams

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Body

namestring · min: 1 · max: 256required

descriptionstring · max: 256required

roleRefsRoleReference[] | nullable

The list of roles assigned to the team

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/teams' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","description":"text","roleRefs":[{"id":"123e4567-e89b-12d3-a456-426614174000","type":"organization","workspaces":[null]}]}'

201

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "createdAt": "2025-02-21T18:08:53.831Z",
  "updatedAt": "2025-02-21T18:08:53.831Z",
  "visibility": "public",
  "accessibility": "open",
  "featuredMembers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user"
    }
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Get team

Retrieve a single team.

get

/organizations/{organizationId}/teams/{teamId}

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/teams/{teamId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "createdAt": "2025-02-21T18:08:53.831Z",
  "updatedAt": "2025-02-21T18:08:53.831Z",
  "visibility": "public",
  "accessibility": "open",
  "featuredMembers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user"
    }
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Delete team

Delete a team from an organization.

delete

/organizations/{organizationId}/teams/{teamId}

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/organizations/{organizationId}/teams/{teamId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Update team

Update a team's details.

patch

/organizations/{organizationId}/teams/{teamId}

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

Body

namestring · min: 1 · max: 256

descriptionstring · max: 256

roleRefsRoleReference[] | nullable

The list of roles assigned to the team

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/teams/{teamId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"roleRefs":[{"id":"123e4567-e89b-12d3-a456-426614174000","type":"organization","workspaces":[null]}]}'

200

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "createdAt": "2025-02-21T18:08:53.831Z",
  "updatedAt": "2025-02-21T18:08:53.831Z",
  "visibility": "public",
  "accessibility": "open",
  "featuredMembers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user"
    }
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}