Members

Last updated 1 year ago

Was this helpful?

Get team member

get

Retrieve a single team member.

Authorizations

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 -L \
  --url '/organizations/{organizationId}/teams/{teamId}/members/{teamMemberId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "user",
  "status": "active",
  "createdAt": "2025-03-28T19:01:51.615Z",
  "updatedAt": "2025-03-28T19:01:51.615Z"
}

Remove team member

delete

Remove a member from a team.

Authorizations

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 -L \
  --request DELETE \
  --url '/organizations/{organizationId}/teams/{teamId}/members/{teamMemberId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

List team members

get

List the members of the team.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

Query parameters

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

Limits the number of results to return

reverseboolean · default: falseoptional

Order in which to retrieve the results

pageTokenstringoptional

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

statusstring · enumoptional

Options: active, invited, requested-to-join

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user",
      "status": "active",
      "createdAt": "2025-03-28T19:01:51.615Z",
      "updatedAt": "2025-03-28T19:01:51.615Z"
    }
  ],
  "nextPageToken": "text"
}

Add team member

post

Add a member to the team.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

teamIdstringrequired

ID for a team

Body

typestring · enumrequired

Options: user

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

404

409

422

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user",
      "status": "active",
      "createdAt": "2025-03-28T19:01:51.615Z",
      "updatedAt": "2025-03-28T19:01:51.615Z"
    }
  ]
}