No-code docs

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
201
Created
application/json
post
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-07-01T22:00:38.493Z",
  "updatedAt": "2025-07-01T22:00:38.493Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ],
  "verified": true
}

Get Organization

get

Get an organization by its ID.

Authorizations
Path parameters
organizationIdstringRequired

The organization ID

Responses
200
OK
application/json
get
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-07-01T22:00:38.493Z",
  "updatedAt": "2025-07-01T22:00:38.493Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ],
  "verified": true
}

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 | 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
patch
PATCH /organizations/{organizationId} HTTP/1.1
Host: 
Authorization: Bearer jwt
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": "2025-07-01T22:00:38.493Z",
  "updatedAt": "2025-07-01T22:00:38.493Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ],
  "verified": true
}

Last updated

Was this helpful?