Team Management

List teams

get

Retrieve a list of teams within the workspace, showcasing their members count and other details.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

sortBystring · enumOptional

Sort by field specified

Possible values:

Responses

200

OK

application/json

404

Workspace not found

application/json

get

/workspaces/{workspaceId}/teams

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/teams HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "visibility": "text",
      "accessibility": "text",
      "activeMemberCount": 1,
      "pendingMemberCount": 1,
      "featuredMembers": [
        {
          "id": "text",
          "type": "text"
        }
      ],
      "hideFromViews": true,
      "createdAt": "2025-12-18T15:08:52.595Z",
      "updatedAt": "2025-12-18T15:08:52.595Z"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Get team

get

Retrieve information about a specific team within the workspace, including its name, and other details.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

teamIdstringRequired

Responses

200

OK

application/json

404

Team or workspace not found

application/json

get

/workspaces/{workspaceId}/teams/{teamId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/teams/{teamId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": true,
  "createdAt": "2025-12-18T15:08:52.595Z",
  "updatedAt": "2025-12-18T15:08:52.595Z"
}

Create team

post

Create a new team within the workspace, defining its name, and other relevant attributes.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Body

application/json

Input for creating a new team.

namestring · min: 5 · max: 20Required

descriptionstring · max: 240Optional

hideFromViewsbooleanOptionalDefault: false

Responses

201

Created

application/json

404

Workspace not found

application/json

422

Invalid request

application/json

post

/workspaces/{workspaceId}/teams

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/teams HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "name": "text",
  "description": "text",
  "hideFromViews": false,
  "members": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": true,
  "createdAt": "2025-12-18T15:08:52.595Z",
  "updatedAt": "2025-12-18T15:08:52.595Z"
}

Update team

patch

Modify the details of a specific team within the workspace, such as its name, or other attributes.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

teamIdstringRequired

Body

application/json

Input for updating a team's properties.

namestring · min: 5 · max: 20Optional

descriptionstring · max: 240Optional

hideFromViewsbooleanOptional

Responses

200

OK

application/json

404

Team or workspace not found

application/json

422

Invalid request

application/json

patch

/workspaces/{workspaceId}/teams/{teamId}

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/teams/{teamId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "text",
  "description": "text",
  "hideFromViews": true
}

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": true,
  "createdAt": "2025-12-18T15:08:52.595Z",
  "updatedAt": "2025-12-18T15:08:52.595Z"
}

Delete team

delete

Remove a specific team from the workspace, permanently deleting its profile and associated data.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

teamIdstringRequired

Responses

204

Deleted

404

Team or workspace not found

application/json

delete

/workspaces/{workspaceId}/teams/{teamId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/teams/{teamId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List members

get

Retrieve a list of members within the team, showcasing their names and other details.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

teamIdstringRequired

Responses

200

OK

application/json

404

Team or workspace not found

application/json

get

/workspaces/{workspaceId}/teams/{teamId}/members

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/teams/{teamId}/members HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "text",
      "teamId": "text",
      "type": "text",
      "status": "text",
      "createdAt": "2025-12-18T15:08:52.595Z",
      "updatedAt": "2025-12-18T15:08:52.595Z"
    }
  ]
}

Create member

post

Add a new member to the team.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

teamIdstringRequired

Body

application/json

idstring · min: 1Required

typestring · enum · min: 1RequiredPossible values:

Responses

201

Created

application/json

404

Team or workspace not found

application/json

409

User is already a member

application/json

422

Invalid request

application/json

post

/workspaces/{workspaceId}/teams/{teamId}/members

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/teams/{teamId}/members HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "id": "text",
  "type": "user"
}

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2025-12-18T15:08:52.595Z",
  "updatedAt": "2025-12-18T15:08:52.595Z"
}

Get member

get

Retrieve information about a specific member within the team, including their name and other details.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

teamIdstringRequired

teamMemberUserIDstringRequired

Responses

200

OK

application/json

404

Member, team or workspace not found

application/json

get

/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2025-12-18T15:08:52.595Z",
  "updatedAt": "2025-12-18T15:08:52.595Z"
}

Remove member

delete

Remove a specific member from the team.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

teamIdstringRequired

teamMemberUserIDstringRequired

Responses

204

deleted

404

Member, team or workspace not found

application/json

delete

/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content