Organizations | Bird API Docs

No-code docs

Get Organization

get

Get an organization by its ID.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "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-03-31T11:30:16.842Z",
  "updatedAt": "2025-03-31T11:30:16.842Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ]
}

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/organizations' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "slug": "text",
    "countryCode": "text"
  }'

201

409

422

{
  "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-03-31T11:30:16.842Z",
  "updatedAt": "2025-03-31T11:30:16.842Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ]
}

Created

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 | nullableoptional

Available options:

statusReasonstring | nullableoptional

The reason for the organization's status

ownerstring · uuidoptional

The organization's owner's ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "avatarUrl": "text",
    "status": "banned",
    "statusReason": "text",
    "owner": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

422

{
  "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-03-31T11:30:16.842Z",
  "updatedAt": "2025-03-31T11:30:16.842Z",
  "managedBy": [
    {
      "Type": "text",
      "ID": "text"
    }
  ]
}