Skip to main content
POST
/
orgs
Create Organization
curl --request POST \
  --url https://api.example.com/orgs \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": ""
}
'
{
  "id": "<string>",
  "name": "<string>",
  "public_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "invite_mode": "<string>",
  "role": "owner",
  "member_count": 123,
  "node_count": 123,
  "root_node_id": "<string>"
}

Headers

authorization
string | null

Body

application/json

Request model for creating a new organization.

name
string
required

Organization name

Required string length: 1 - 255
description
string | null
default:""

Organization description

Response

Successful Response

Response model for organization data.

id
string
required

Organization ID

name
string
required

Organization name

public_id
string
required

URL-friendly public identifier

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

description
string | null

Organization description

invite_mode
string | null

Invite mode (open or restricted)

role
enum<string> | null

Current user's role

Available options:
owner,
editor,
viewer
member_count
integer | null

Number of members

node_count
integer | null

Number of nodes

root_node_id
string | null

ID of the organization's root node