Orgs API
Orgs (hats) and settings
GET /orgs
The orgs the caller belongs to (for org-bound tokens, just that org).
Responses
200- OK. Paged_Org
application/json
POST /orgs
Creates a shared org, with the caller as owner and an open General space.
Request body
application/json, CreateOrg.
| Field | Type | Description |
|---|---|---|
handle | string | null | Your handle in the new org (default: your personal handle). |
name required | string | The name. |
slug required | string | The slug (2–32 of a-z 0-9 _ -, not reserved). |
Responses
201- Created. Org
application/json 409- Conflict. ProblemBody
application/json
GET /orgs/{org}
An org.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Responses
200- OK. Org
application/json
PATCH /orgs/{org}
Renames an org (admins).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Request body
application/json, UpdateOrg.
| Field | Type | Description |
|---|---|---|
name | string | null | The name. |
Responses
200- OK. Org
application/json
DELETE /orgs/{org}
Deletes a shared org (owner only). It's purged after 30 days.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Responses
204- No content
GET /orgs/{org}/settings
The org's settings.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Responses
200- OK. Settings
application/json
PATCH /orgs/{org}/settings
Changes settings (admins). Keys in the body replace stored values; null restores the default.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Request body
application/json, Settings.
Responses
200- OK. Settings
application/json