Teams

List teams

List the teams inside an organization.

GET/organizations/{organizationId}/teams

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Query parameters

Response

200404

OK

Body

application/json

results*array of Team

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/teams', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "visibility": "public",
      "accessibility": "open",
      "activeMemberCount": 0,
      "pendingMemberCount": 0,
      "featuredMembers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "createdAt": "2025-01-21T01:39:13.680Z",
      "updatedAt": "2025-01-21T01:39:13.680Z"
    }
  ],
  "nextPageToken": "text"
}

Create team

Create a new team inside the organization.

POST/organizations/{organizationId}/teams

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Body

application/json

name*string

description*string

roleRefsnullable array of RoleReference

The list of roles assigned to the team

Response

201404422

OK

Body

application/json

id*string (uuid)

name*string

description*string

visibility*enum

publicprivate

accessibility*enum

openrequest-to-joininvite-only

activeMemberCount*integer

pendingMemberCount*integer

featuredMembers*array of TeamMemberReference

roleRefsnullable array of RoleReference

The list of roles assigned to the team

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/teams', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "description": "text"
    }),
});
const data = await response.json();

Response

201404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "visibility": "public",
  "accessibility": "open",
  "activeMemberCount": 0,
  "pendingMemberCount": 0,
  "featuredMembers": [
    {
      "type": "user",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "createdAt": "2025-01-21T01:39:13.680Z",
  "updatedAt": "2025-01-21T01:39:13.680Z"
}

Get team

Retrieve a single team.

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

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

teamId*string

ID for a team

Response

200404

OK

Body

application/json

id*string (uuid)

name*string

description*string

visibility*enum

publicprivate

accessibility*enum

openrequest-to-joininvite-only

activeMemberCount*integer

pendingMemberCount*integer

featuredMembers*array of TeamMemberReference

roleRefsnullable array of RoleReference

The list of roles assigned to the team

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/teams/{teamId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "visibility": "public",
  "accessibility": "open",
  "activeMemberCount": 0,
  "pendingMemberCount": 0,
  "featuredMembers": [
    {
      "type": "user",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "createdAt": "2025-01-21T01:39:13.680Z",
  "updatedAt": "2025-01-21T01:39:13.680Z"
}

Delete team

Delete a team from an organization.

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

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

teamId*string

ID for a team

Response

204404

OK

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/teams/{teamId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

Update team

Update a team's details.

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

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

teamId*string

ID for a team

Body

application/json

namestring

descriptionstring

roleRefsnullable array of RoleReference

The list of roles assigned to the team

Response

200404422

OK

Body

application/json

id*string (uuid)

name*string

description*string

visibility*enum

publicprivate

accessibility*enum

openrequest-to-joininvite-only

activeMemberCount*integer

pendingMemberCount*integer

featuredMembers*array of TeamMemberReference

roleRefsnullable array of RoleReference

The list of roles assigned to the team

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/teams/{teamId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "visibility": "public",
  "accessibility": "open",
  "activeMemberCount": 0,
  "pendingMemberCount": 0,
  "featuredMembers": [
    {
      "type": "user",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "createdAt": "2025-01-21T01:39:13.680Z",
  "updatedAt": "2025-01-21T01:39:13.680Z"
}