Memberships

List organization memberships

get

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

Authorizations
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
Responseall of
get
/me/memberships
GET /me/memberships HTTP/1.1
Host: 
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": "2025-11-27T07:15:47.571Z",
        "updatedAt": "2025-11-27T07:15:47.571Z",
        "managedBy": [
          {
            "Type": "text",
            "ID": "text"
          }
        ],
        "verified": true
      },
      "status": "banned",
      "createdAt": "2025-11-27T07:15:47.571Z",
      "updatedAt": "2025-11-27T07:15:47.571Z",
      "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
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
organizationIdstringRequired

The organization ID

Responses
200

OK

application/json
get
/me/memberships/{organizationId}
GET /me/memberships/{organizationId} HTTP/1.1
Host: 
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": "2025-11-27T07:15:47.571Z",
    "updatedAt": "2025-11-27T07:15:47.571Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ],
    "verified": true
  },
  "status": "banned",
  "createdAt": "2025-11-27T07:15:47.571Z",
  "updatedAt": "2025-11-27T07:15:47.571Z",
  "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
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
organizationIdstringRequired

The organization ID

Responses
200

OK

application/json
post
/me/memberships/{organizationId}
POST /me/memberships/{organizationId} HTTP/1.1
Host: 
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": "2025-11-27T07:15:47.571Z",
    "updatedAt": "2025-11-27T07:15:47.571Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ],
    "verified": true
  },
  "status": "banned",
  "createdAt": "2025-11-27T07:15:47.571Z",
  "updatedAt": "2025-11-27T07:15:47.571Z",
  "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
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
organizationIdstringRequired

The organization ID

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

No content

Last updated

Was this helpful?