Members

List team members

List the members of the team.

get

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

Authorizations

useraccessKey

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

reverseboolean

Order in which to retrieve the results

pageTokenstring

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

statusstring · enum

Options: active, invited, requested-to-join

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-21T18:06:01.180Z",
      "updatedAt": "2025-02-21T18:06:01.180Z",
      "type": "user",
      "status": "active"
    }
  ],
  "nextPageToken": "text"
}

OK

Add team member

Add a member to the team.

post

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

Authorizations

useraccessKey

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

Body

idstring · uuidrequired

typestring · enumrequired

Options: user

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/teams/{teamId}/members' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"id":"123e4567-e89b-12d3-a456-426614174000","type":"user"}'

201

404

409

422

201

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-21T18:06:01.180Z",
      "updatedAt": "2025-02-21T18:06:01.180Z",
      "type": "user",
      "status": "active"
    }
  ]
}

OK

Get team member

Retrieve a single team member.

get

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

Authorizations

useraccessKey

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

teamMemberIdstringrequired

ID for a team member

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{organizationId}/teams/{teamId}/members/{teamMemberId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-21T18:06:01.180Z",
  "updatedAt": "2025-02-21T18:06:01.180Z",
  "type": "user",
  "status": "active"
}

OK

Remove team member

Remove a member from a team.

delete

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

Authorizations

useraccessKey

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

teamMemberIdstringrequired

ID for a team member

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/organizations/{organizationId}/teams/{teamId}/members/{teamMemberId}' \
  --header 'Authorization: Bearer jwt'

204

404

204

No body

OK