Proteside Docs
Endpoint referenceOrganizations

Create a child organization (partner)

POST
/organizations

Creates an organization with parent_org_id = your organization. The owner receives an invitation e-mail (tolerant to failure: see owner_invite). Default approval policies are seeded. Only one level of nesting is allowed.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.

Header Parameters

Idempotency-Key?string

Replays the original response for 24 h

Length1 <= length <= 255

Request Body

application/json
  1. body
name*string
Length2 <= length <= 120
owner_email*string
Formatemail
plan?string
Default"growth"
Value in"essential""standard""growth""pro""enterprise"
billing_mode?string
Default"partner"
Value in"partner""stripe"

Response Body

Created

application/json
  1. response
id?string
Formatuuid
name?string
plan?string
billing_mode?string
Value in"stripe""partner"
parent_org_id?|
Formatuuid
owner_email?|
Formatemail
partner_settings?
created_at?string
Formatdate-time
owner_invite?string
Value in"sent""existing_user""failed""skipped"
curl -X POST "https://example.com/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "Loja do João",    "owner_email": "joao@lojadojoao.com.br",    "plan": "growth"  }'
{  "id": "7f3c1e2a-0b4d-4c8e-9f10-2a3b4c5d6e7f",  "name": "Loja do João",  "plan": "growth",  "billing_mode": "partner",  "parent_org_id": "a1b2c3d4-0000-4000-8000-000000000001",  "owner_email": "joao@lojadojoao.com.br",  "partner_settings": {},  "created_at": "2026-09-27T10:00:00.000Z",  "owner_invite": "sent"}