No-code docs

Team Management

List teams

get

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

Authorizations
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
Responseall of
get
/workspaces/{workspaceId}/teams
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-11-27T03:25:17.362Z",
      "updatedAt": "2025-11-27T03:25:17.362Z"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Get team

get

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

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
teamIdstringRequired
Responses
200

OK

application/json
get
/workspaces/{workspaceId}/teams/{teamId}
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-11-27T03:25:17.362Z",
  "updatedAt": "2025-11-27T03:25:17.362Z"
}

Create team

post

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

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Body

Input for creating a new team.

namestring · min: 5 · max: 20Required
descriptionstring · max: 240Optional
hideFromViewsbooleanOptionalDefault: false
Responses
post
/workspaces/{workspaceId}/teams
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-11-27T03:25:17.362Z",
  "updatedAt": "2025-11-27T03:25:17.362Z"
}

Update team

patch

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

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
teamIdstringRequired
Body

Input for updating a team's properties.

namestring · min: 5 · max: 20Optional
descriptionstring · max: 240Optional
hideFromViewsbooleanOptional
Responses
200

OK

application/json
patch
/workspaces/{workspaceId}/teams/{teamId}
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-11-27T03:25:17.362Z",
  "updatedAt": "2025-11-27T03:25:17.362Z"
}

Delete team

delete

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

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
teamIdstringRequired
Responses
delete
/workspaces/{workspaceId}/teams/{teamId}
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
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
teamIdstringRequired
Responses
200

OK

application/json
get
/workspaces/{workspaceId}/teams/{teamId}/members
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-11-27T03:25:17.362Z",
      "updatedAt": "2025-11-27T03:25:17.362Z"
    }
  ]
}

Create member

post

Add a new member to the team.

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
teamIdstringRequired
Body
idstring · min: 1Required
typestring · enum · min: 1RequiredPossible values:
Responses
post
/workspaces/{workspaceId}/teams/{teamId}/members
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-11-27T03:25:17.362Z",
  "updatedAt": "2025-11-27T03:25:17.362Z"
}

Get member

get

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

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
teamIdstringRequired
teamMemberUserIDstringRequired
Responses
200

OK

application/json
get
/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}
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-11-27T03:25:17.362Z",
  "updatedAt": "2025-11-27T03:25:17.362Z"
}

Remove member

delete

Remove a specific member from the team.

Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
teamIdstringRequired
teamMemberUserIDstringRequired
Responses
delete
/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}
DELETE /workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated

Was this helpful?