Tolgee Octri Demo
GET/v2/organizations/{slug}

Get an organization by slug

Retrieves an organization by its slug. Use the slug to look up the organization and inspect its name, description, base permissions, and the authenticated user's role. The returned role can be null when the authenticated user has direct access to one of the organization's projects.

1 parameter
slugstringrequired
The string slug that identifies the organization to retrieve.

5 status codes
200Returns the organization, including its identifier, name, slug, base permissions, description, avatar, and the authenticated user's role when available.
avatarobjectoptional
basePermissionsobjectrequired
currentUserRolestringoptional
The role of currently authorized user. Can be null when user has direct access to one of the projects owned by the organization.
Allowed:MEMBEROWNERMAINTAINER
descriptionstringoptional
idintegerrequired
namestringrequired
slugstringrequired
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to access the organization.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when no organization matches the supplied slug.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the request is not authenticated, and a 403 when the authenticated user cannot access the organization. A 404 is returned when no organization matches the slug path parameter.