Returns your organisation with its settings and your role in it.
HTTP
GET /orgAccess: Session token only. API keys get 403 with insufficient_scope.
Response 200 #
The organisation.
JSON
{
"id": "0197a3c1-0c11-7a02-8f3d-2b6e4d9c7a10",
"name": "Acme",
"settings": {
"localization": {
"sourceLanguage": "English (US)",
"timezone": "UTC+01:00 - Amsterdam",
"messageFormat": "ICU (recommended)",
"machineTranslation": "Suggestions only"
},
"profile": { "description": "", "industry": "Software & SaaS", "size": "11–50" },
"security": { "require2fa": false, "restrictDomains": false, "domains": [], "sessionTimeout": "7 days", "passwordMinLength": 8, "passwordRequireMix": false, "apiKeyMaxDays": null, "ipAllowlist": [], "auditRetentionDays": null, "dataRegion": null }
},
"role": "owner"
}Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the organisation. |
name | string | The name. |
settings.localization | object | sourceLanguage, timezone, messageFormat and machineTranslation, free text. The app shows the first three; machineTranslation is no longer used, see Machine translation. |
settings.profile | object | description, industry and size. |
settings.security | object | require2fa, restrictDomains and passwordRequireMix (booleans), domains (list of strings such as @example.com), sessionTimeout, passwordMinLength, apiKeyMaxDays, ipAllowlist, auditRetentionDays and dataRegion (a region code such as eu, us or jp, or null for no preference; the codes are listed under Update the organisation). |
role | string | Your role in the organisation: owner, admin or member. Only in the response of Get the organisation. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.