Get organization settings | API Reference

Retrieve the settings for a specific organization by ID.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Response

billingobject

created_atdatetimeRead-only

custom_scripts_enabledstringRead-only

email_notification_settingsstringRead-only

idintegerRead-only

react_code_settingsstringRead-only

titlestringRead-only

tokenstringRead-only

default_roleenum

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

List of objects: {“domain”: “example.com”}. Used for CSP header on /embed routes.

embed_settingsany or null

Embed settings for this organization

external_idstring or null

External ID to uniquely identify this organization

1	{
2	"billing": {
3	"enforce_session_concurrency": "true",
4	"manual_role_management": "false",
5	"manual_workspace_management": "true",
6	"max_parallel_sessions": "5",
7	"session_concurrency_window_seconds": "3600"
8	},
9	"created_at": "2024-01-15T09:30:00Z",
10	"custom_scripts_enabled": "enabled",
11	"email_notification_settings": "daily_summary",
12	"id": 1,
13	"react_code_settings": "default",
14	"title": "Acme Corporation",
15	"token": "a1b2c3d4e5f67890abcdef1234567890",
16	"default_role": "OW",
17	"external_id": "org-2024-001"
18	}

1	curl http://localhost:8000/api/organizations/1 \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json"