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

Get an organization

Retrieves an organization by its numeric ID. Use this endpoint to inspect the organization's name, slug, description, base permissions, and the authenticated user's organization role.

1 parameter
idintegerrequired
The int64 numeric identifier of the organization to retrieve.

5 status codes
200Returns the organization, including its ID, name, slug, description, base permissions, and current user's organization role.
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 organization ID 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 unauthenticated.
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 access is forbidden.
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 the organization is not found.
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 id path parameter is invalid. A 401 indicates an unauthenticated request, a 403 indicates access is forbidden, and a 404 indicates the organization was not found.