Organizations

Create Organization

post

Create a new organization for the current user.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Body

application/json

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

201

Created

application/json

409

The resource already exists

application/json

422

Request validation failed

application/json

post

/organizations

HTTPcURLJavaScriptPython

POST /organizations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-03-09T19:04:46.086Z",
  "updatedAt": "2026-03-09T19:04:46.086Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ],
  "verified": true
}

Get Organization

get

Get an organization by its ID.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

organizationIdstringRequired

The organization ID

Responses

200

OK

application/json

The organization record

idstring · uuidRequired

The organization's ID

namestring · min: 1 · max: 256Required

Organization's display name.

slugstringRequired

Human-readable identifier

avatarUrlstringOptional

URL to the organization avatar.

statusstring · enumRequired

Current status

Default: activePossible values:

statusReasonstringOptional

The reason for the organization's status (if any).

pendingMemberCountintegerOptional

How many members are pending to join the organization

activeMemberCountintegerRequired

How many members are active

ownerstring · uuidRequired

ID of the user that owns the organization

createdAtstring · date-timeRequired

When the organization was created

updatedAtstring · date-timeOptional

When the organization was last updated

verifiedboolean · nullableOptional

404

Resource not found

application/json

get

/organizations/{organizationId}

HTTPcURLJavaScriptPython

GET /organizations/{organizationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-03-09T19:04:46.086Z",
  "updatedAt": "2026-03-09T19:04:46.086Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ],
  "verified": true
}

Update Organization

patch

Update an organization's properties.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

organizationIdstringRequired

The organization ID

Body

application/json

namestring · min: 1 · max: 256Optional

Organization's display name.

avatarUrlstringOptional

The url of the avatar displayed next to the org

statusstring · enum · nullableOptionalPossible values:

statusReasonstring · nullableOptional

The reason for the organization's status

ownerstring · uuidOptional

The organization's owner's ID

verifiedboolean · nullableOptional

Responses

200

OK

application/json

The organization record

idstring · uuidRequired

The organization's ID

namestring · min: 1 · max: 256Required

Organization's display name.

slugstringRequired

Human-readable identifier

avatarUrlstringOptional

URL to the organization avatar.

statusstring · enumRequired

Current status

Default: activePossible values:

statusReasonstringOptional

The reason for the organization's status (if any).

pendingMemberCountintegerOptional

How many members are pending to join the organization

activeMemberCountintegerRequired

How many members are active

ownerstring · uuidRequired

ID of the user that owns the organization

createdAtstring · date-timeRequired

When the organization was created

updatedAtstring · date-timeOptional

When the organization was last updated

verifiedboolean · nullableOptional

403

Forbidden operation

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

patch

/organizations/{organizationId}

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

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

{
  "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-09T19:04:46.086Z",
  "updatedAt": "2026-03-09T19:04:46.086Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ],
  "verified": true
}