Members

Last updated 2 years 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

200

application/json

404

Resource not found

application/json

get

GET /organizations/{organizationId}/teams/{teamId}/members/{teamMemberId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "user",
  "status": "active",
  "createdAt": "2025-05-09T05:49:15.290Z",
  "updatedAt": "2025-05-09T05:49:15.290Z"
}

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

204

404

Resource not found

application/json

delete

DELETE /organizations/{organizationId}/teams/{teamId}/members/{teamMemberId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

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: 100Optional

Limits the number of results to return

Default: 10

reversebooleanOptional

Order in which to retrieve the results

Default: false

pageTokenstringOptional

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

statusstring · enumOptionalPossible values:

Responses

200

application/json

Responseall of

and

404

Resource not found

application/json

get

GET /organizations/{organizationId}/teams/{teamId}/members HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user",
      "status": "active",
      "createdAt": "2025-05-09T05:49:15.290Z",
      "updatedAt": "2025-05-09T05:49:15.290Z"
    }
  ],
  "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 · enumRequiredPossible values:

idstring · uuidRequired

Responses

201

application/json

404

Resource not found

application/json

409

The resource already exists

application/json

422

Request validation failed

application/json

post

POST /organizations/{organizationId}/teams/{teamId}/members HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "type": "user",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "user",
      "status": "active",
      "createdAt": "2025-05-09T05:49:15.290Z",
      "updatedAt": "2025-05-09T05:49:15.290Z"
    }
  ]
}