Organizations

Create Organization

post

Create a new organization for the current user.

Authorizations

Body

namestring · min: 1 · max: 256Required

Organization's display name.

slugstring · min: 1 · max: 253Required

Organization's human-readable identifier.

Pattern: ^[a-zA-Z0-9-]+$

countryCodestring · iso3166-1Required

The country in which the organization operates.

Responses

application/json

objectOptional

The organization record

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /organizations HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "slug": "text",
  "countryCode": "text"
}

{
  "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-04-22T04:59:46.606Z",
  "updatedAt": "2025-04-22T04:59:46.606Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ]
}

Get Organization

get

Get an organization by its ID.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Responses

application/json

objectOptional

The organization record

application/json

get

HTTPcURLJavaScriptPython

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

{
  "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-04-22T04:59:46.606Z",
  "updatedAt": "2025-04-22T04:59:46.606Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ]
}

Update Organization

patch

Update an organization's properties.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Body

namestring · min: 1 · max: 256Optional

Organization's display name.

avatarUrlstringOptional

The url of the avatar displayed next to the org

statusstring · enum | nullableOptionalAvailable options:

statusReasonstring | nullableOptional

The reason for the organization's status

ownerstring · uuidOptional

The organization's owner's ID

Responses

application/json

objectOptional

The organization record

application/json

application/json

application/json

patch

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "text",
  "avatarUrl": "text",
  "status": "banned",
  "statusReason": "text",
  "owner": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "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-04-22T04:59:46.606Z",
  "updatedAt": "2025-04-22T04:59:46.606Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ]
}