Members

List team members

List the members of the team.

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

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

teamId*string

ID for a team

Query parameters

Response

200404

OK

Body

application/json

resultsarray of TeamMember

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/{teamId}/members', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user",
      "status": "active",
      "createdAt": "2024-11-21T08:54:42.358Z",
      "updatedAt": "2024-11-21T08:54:42.358Z"
    }
  ],
  "nextPageToken": "text"
}

Add team member

Add a member to the team.

POST/organizations/{organizationId}/teams/{teamId}/members

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

teamId*string

ID for a team

Body

application/json

type*enum

user

id*string (uuid)

Response

201404409422

OK

Body

application/json

resultsarray of TeamMember

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/teams/{teamId}/members', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "user",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

201404409422

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user",
      "status": "active",
      "createdAt": "2024-11-21T08:54:42.358Z",
      "updatedAt": "2024-11-21T08:54:42.358Z"
    }
  ]
}

Get team member

Retrieve a single team member.

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

Authorization

useraccessKey

Response

200404

OK

Body

application/json

id*string (uuid)

type*enum

user

status*enum

activeinvitedrequested-to-join

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "user",
  "status": "active",
  "createdAt": "2024-11-21T08:54:42.358Z",
  "updatedAt": "2024-11-21T08:54:42.358Z"
}

Remove team member

Remove a member from a team.

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

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

teamId*string

ID for a team

teamMemberId*string

ID for a team member

Response

204404

OK

Request

JavaScriptCurlPython

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

Response

404

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