Skip to main content
POST
/
v1
/
provisioning
/
clients
Provision Client Endpoint
curl --request POST \
  --url https://api.example.com/v1/provisioning/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": {
    "name": "<string>",
    "slug": "<string>",
    "plan": "free",
    "seats": 10,
    "timezone": "UTC"
  },
  "owner": {
    "email": "jsmith@example.com",
    "name": "<string>"
  },
  "isolation_mode": "<string>",
  "issue_api_key": true,
  "send_owner_invite": true,
  "workspace": {
    "name": "<string>"
  }
}
'
{
  "created": true,
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "plan": "<string>",
    "slug": "<string>"
  },
  "owner": {
    "email": "<string>",
    "membership_id": "<string>",
    "role": "<string>",
    "user_id": "<string>"
  },
  "workspace": {
    "id": "<string>",
    "name": "<string>"
  },
  "api_key": {
    "id": "<string>",
    "scopes": [
      "<string>"
    ],
    "secret": "<string>",
    "note": "shown once — store it securely; it cannot be retrieved again"
  },
  "owner_invite": {
    "id": "<string>",
    "url": "<string>",
    "expires_at": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string | null

Body

application/json
organization
ProvisionOrganization · object
required
owner
ProvisionOwner · object
required
isolation_mode
string | null
issue_api_key
boolean
default:true
send_owner_invite
boolean
default:true
workspace
ProvisionWorkspace · object | null

Response

Successful Response

created
boolean
required
organization
ProvisionOrganizationOut · object
required
owner
ProvisionOwnerOut · object
required
workspace
ProvisionWorkspaceOut · object
required
api_key
ProvisionedApiKey · object | null
owner_invite
ProvisionedInvite · object | null