Memberships

Last updated 9 months ago

Was this helpful?

List organization memberships

get

Retrieve a list of all organizations the user is a member of

Authorizations

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

The status of user's membership on the organization.

Options: banned, invited, active

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/me/memberships' \
  --header 'Authorization: Bearer jwt'

200

422

{
  "nextPageToken": "text",
  "results": [
    {
      "organization": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "slug": "text",
        "avatarUrl": "text",
        "status": "active",
        "statusReason": "text",
        "pendingMemberCount": 1,
        "activeMemberCount": 1,
        "owner": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-03-28T18:52:12.097Z",
        "updatedAt": "2025-03-28T18:52:12.097Z",
        "managedBy": [
          {
            "Type": "text",
            "ID": "text"
          }
        ]
      },
      "status": "banned",
      "createdAt": "2025-03-28T18:52:12.097Z",
      "updatedAt": "2025-03-28T18:52:12.097Z",
      "roleIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "requiredSsoAuth": true,
      "requiredMfaAuth": true
    }
  ]
}

Get organization membership

get

Retrieve a single organization membership object.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/me/memberships/{organizationId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "slug": "text",
    "avatarUrl": "text",
    "status": "active",
    "statusReason": "text",
    "pendingMemberCount": 1,
    "activeMemberCount": 1,
    "owner": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-03-28T18:52:12.097Z",
    "updatedAt": "2025-03-28T18:52:12.097Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ]
  },
  "status": "banned",
  "createdAt": "2025-03-28T18:52:12.097Z",
  "updatedAt": "2025-03-28T18:52:12.097Z",
  "roleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "requiredSsoAuth": true,
  "requiredMfaAuth": true
}

Accept organization invitation

post

Accept a pending invitation to join the organization.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/me/memberships/{organizationId}' \
  --header 'Authorization: Bearer jwt'

200

404

409

{
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "slug": "text",
    "avatarUrl": "text",
    "status": "active",
    "statusReason": "text",
    "pendingMemberCount": 1,
    "activeMemberCount": 1,
    "owner": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-03-28T18:52:12.097Z",
    "updatedAt": "2025-03-28T18:52:12.097Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ]
  },
  "status": "banned",
  "createdAt": "2025-03-28T18:52:12.097Z",
  "updatedAt": "2025-03-28T18:52:12.097Z",
  "roleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "requiredSsoAuth": true,
  "requiredMfaAuth": true
}

Leave organization

delete

Remove the membership from the organization for the current user

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/me/memberships/{organizationId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body