Get organization settings | API Reference

Retrieve the settings for a specific organization by ID.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path Parameters

idintegerRequired

Response

billingobject

created_atdatetime

custom_scripts_enabledstring

email_notification_settingsstring

idinteger

titlestring

tokenstring

default_roleenum or null

Default membership role for invited users

OW - Owner
AD - Administrator
MA - Manager
RE - Reviewer
AN - Annotator
DI - Deactivated
NO - Not Activated

Default membership role for invited users * `OW` - Owner * `AD` - Administrator * `MA` - Manager * `RE` - Reviewer * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated

embed_domainsany or null

embed_settingsany or null

external_idstring or null

External ID to uniquely identify this organization

1	{
2	"billing": {
3	"manual_role_management": "manual_role_management",
4	"manual_workspace_management": "manual_workspace_management"
5	},
6	"created_at": "2024-01-15T09:30:00Z",
7	"custom_scripts_enabled": "custom_scripts_enabled",
8	"email_notification_settings": "email_notification_settings",
9	"id": 1,
10	"title": "title",
11	"token": "token",
12	"default_role": "OW",
13	"embed_domains": {
14	"key": "value"
15	},
16	"embed_settings": {
17	"key": "value"
18	},
19	"external_id": "external_id"
20	}

1	curl http://localhost:8000/api/organizations/1 \
2	-H "Authorization: Token <api_key>"