Team Management

Last updated 5 months ago

Was this helpful?

List teams

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

get

/workspaces/{workspaceId}/teams

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger

Limits the number of results to return

pageTokenstring

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

reverseboolean

Order in which to retrieve the results

sortByenum

Sort by field specified

Options: name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/teams' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "visibility": "text",
      "accessibility": "text",
      "activeMemberCount": 1,
      "pendingMemberCount": 1,
      "hideFromViews": true,
      "createdAt": "2025-02-18T22:17:07.950Z",
      "updatedAt": "2025-02-18T22:17:07.950Z",
      "featuredMembers": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Get team

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

get

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

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "hideFromViews": true,
  "createdAt": "2025-02-18T22:17:07.950Z",
  "updatedAt": "2025-02-18T22:17:07.950Z",
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

Create team

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

post

/workspaces/{workspaceId}/teams

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestringrequired

descriptionstring

hideFromViewsboolean

membersobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/teams' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","hideFromViews":false,"members":[{"id":"text","type":"text"}]}'

201

404

422

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "hideFromViews": true,
  "createdAt": "2025-02-18T22:17:07.950Z",
  "updatedAt": "2025-02-18T22:17:07.950Z",
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

Created

Update team

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

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Body

namestring

descriptionstring

hideFromViewsboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/teams/{teamId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json'

200

404

422

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "activeMemberCount": 1,
  "pendingMemberCount": 1,
  "hideFromViews": true,
  "createdAt": "2025-02-18T22:17:07.950Z",
  "updatedAt": "2025-02-18T22:17:07.950Z",
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

Delete team

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

delete

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

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

Deleted

List members

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

get

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

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "text",
      "teamId": "text",
      "type": "text",
      "status": "text",
      "createdAt": "2025-02-18T22:17:07.950Z",
      "updatedAt": "2025-02-18T22:17:07.950Z"
    }
  ]
}

Create member

Add a new member to the team.

post

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

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

Body

idstringrequired

typeenumrequired

Options: user

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","type":"user"}'

201

404

409

422

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2025-02-18T22:17:07.950Z",
  "updatedAt": "2025-02-18T22:17:07.950Z"
}

Created

Get member

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

get

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

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

teamMemberUserIDstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2025-02-18T22:17:07.950Z",
  "updatedAt": "2025-02-18T22:17:07.950Z"
}

Remove member

Remove a specific member from the team.

delete

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

Authorizations

Path parameters

workspaceIdstringrequired

teamIdstringrequired

teamMemberUserIDstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

deleted