Team Management

List teams

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

GET/workspaces/{workspaceId}/teams

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of Team (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalinteger

The total number of results across all pages.

Request

JavaScriptCurlPython

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

Response

200404

{
  "results": [
    {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "visibility": "text",
      "accessibility": "text",
      "featuredMembers": [
        {
          "id": "text",
          "type": "text"
        }
      ],
      "hideFromViews": false,
      "createdAt": "2024-11-21T09:14:40.219Z",
      "updatedAt": "2024-11-21T09:14:40.219Z"
    }
  ],
  "nextPageToken": "text"
}

Get team

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

teamId*string

Response

200404

OK

Body

application/json

id*string

workspaceId*string

name*string

description*string

visibility*string

accessibilitystring

activeMemberCount*integer

pendingMemberCount*integer

featuredMembers*array of object

hideFromViews*boolean

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": false,
  "createdAt": "2024-11-21T09:14:40.219Z",
  "updatedAt": "2024-11-21T09:14:40.219Z"
}

Create team

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

POST/workspaces/{workspaceId}/teams

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

descriptionstring

hideFromViewsboolean

Response

201404422

Created

Body

application/json

id*string

workspaceId*string

name*string

description*string

visibility*string

accessibilitystring

activeMemberCount*integer

pendingMemberCount*integer

featuredMembers*array of object

hideFromViews*boolean

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

201404422

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": false,
  "createdAt": "2024-11-21T09:14:40.219Z",
  "updatedAt": "2024-11-21T09:14:40.219Z"
}

Update team

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

teamId*string

Body

application/json

namestring

descriptionstring

hideFromViewsboolean

Response

200404422

OK

Body

application/json

id*string

workspaceId*string

name*string

description*string

visibility*string

accessibilitystring

activeMemberCount*integer

pendingMemberCount*integer

featuredMembers*array of object

hideFromViews*boolean

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200404422

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "visibility": "text",
  "accessibility": "text",
  "featuredMembers": [
    {
      "id": "text",
      "type": "text"
    }
  ],
  "hideFromViews": false,
  "createdAt": "2024-11-21T09:14:40.219Z",
  "updatedAt": "2024-11-21T09:14:40.219Z"
}

Delete team

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

teamId*string

Response

204404

Deleted

Request

JavaScriptCurlPython

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

Response

404

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

List members

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string

teamId*string

Response

200404

OK

Body

application/json

results*array of Membership (object)

Request

JavaScriptCurlPython

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

Response

200404

{
  "results": [
    {
      "id": "text",
      "teamId": "text",
      "type": "text",
      "status": "text",
      "createdAt": "2024-11-21T09:14:40.219Z",
      "updatedAt": "2024-11-21T09:14:40.219Z"
    }
  ]
}

Create member

Add a new member to the team.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

teamId*string

Body

application/json

id*string

type*enum

user

Response

201404409422

Created

Body

application/json

id*string

teamId*string

type*string

status*string

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/teams/{teamId}/members', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "type": "user"
    }),
});
const data = await response.json();

Response

201404409422

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2024-11-21T09:14:40.219Z",
  "updatedAt": "2024-11-21T09:14:40.219Z"
}

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}

Authorization

useraccessKey

Path parameters

workspaceId*string

teamId*string

teamMemberUserID*string

Response

200404

OK

Body

application/json

id*string

teamId*string

type*string

status*string

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "teamId": "text",
  "type": "text",
  "status": "text",
  "createdAt": "2024-11-21T09:14:40.219Z",
  "updatedAt": "2024-11-21T09:14:40.219Z"
}

Remove member

Remove a specific member from the team.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

teamId*string

teamMemberUserID*string

Response

204404

deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/teams/{teamId}/members/user/{teamMemberUserID}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

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