Memberships

List organization memberships

get

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

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

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 · enumOptional

The status of user's membership on the organization.

Possible values:

Responses

200

OK

application/json

422

Request validation failed

application/json

get

/me/memberships

HTTPcURLJavaScriptPython

GET /me/memberships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-03-09T17:38:24.026Z",
        "updatedAt": "2026-03-09T17:38:24.026Z",
        "managedBy": [
          {
            "Type": "text",
            "ID": "text"
          }
        ],
        "verified": true
      },
      "status": "banned",
      "createdAt": "2026-03-09T17:38:24.026Z",
      "updatedAt": "2026-03-09T17:38:24.026Z",
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "requiredSsoAuth": true,
      "requiredMfaAuth": true,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Get organization membership

get

Retrieve a single organization membership object.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

organizationIdstringRequired

The organization ID

Responses

200

OK

application/json

statusstring · enumRequired

The status of user's membership on the organization.

Possible values:

createdAtstring · date-timeRequired

When the membership was created.

updatedAtstring · date-timeRequired

When the membership was last updated.

roleIdsstring · uuid[] · nullableOptionalDeprecated

IDs of IAM roles assigned to the user.

requiredSsoAuthbooleanOptional

Indicates if SSO Authentication is required for this membership

requiredMfaAuthbooleanOptional

Indicates if MFA Authentication is required for this membership

404

Resource not found

application/json

get

/me/memberships/{organizationId}

HTTPcURLJavaScriptPython

GET /me/memberships/{organizationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-03-09T17:38:24.026Z",
    "updatedAt": "2026-03-09T17:38:24.026Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ],
    "verified": true
  },
  "status": "banned",
  "createdAt": "2026-03-09T17:38:24.026Z",
  "updatedAt": "2026-03-09T17:38:24.026Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "requiredSsoAuth": true,
  "requiredMfaAuth": true,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Accept organization invitation

post

Accept a pending invitation to join the organization.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

organizationIdstringRequired

The organization ID

Responses

200

OK

application/json

statusstring · enumRequired

The status of user's membership on the organization.

Possible values:

createdAtstring · date-timeRequired

When the membership was created.

updatedAtstring · date-timeRequired

When the membership was last updated.

roleIdsstring · uuid[] · nullableOptionalDeprecated

IDs of IAM roles assigned to the user.

requiredSsoAuthbooleanOptional

Indicates if SSO Authentication is required for this membership

requiredMfaAuthbooleanOptional

Indicates if MFA Authentication is required for this membership

404

Resource not found

application/json

409

The HTTP 409 Conflict response status code indicates a request conflict with current state of the target resource.

application/json

post

/me/memberships/{organizationId}

HTTPcURLJavaScriptPython

POST /me/memberships/{organizationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-03-09T17:38:24.026Z",
    "updatedAt": "2026-03-09T17:38:24.026Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ],
    "verified": true
  },
  "status": "banned",
  "createdAt": "2026-03-09T17:38:24.026Z",
  "updatedAt": "2026-03-09T17:38:24.026Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "requiredSsoAuth": true,
  "requiredMfaAuth": true,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Leave organization

delete

Remove the membership from the organization for the current user

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

organizationIdstringRequired

The organization ID

Responses

204

OK

404

Resource not found

application/json

delete

/me/memberships/{organizationId}

HTTPcURLJavaScriptPython

DELETE /me/memberships/{organizationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content