Tolgee Octri Demo
GET/v2/projects/{projectId}

Get a project

Retrieves a project by its numeric ID. Use this operation to inspect the project's settings, language and permission details, and other project metadata.

1 parameter
projectIdintegerrequired
The numeric ID of the project to retrieve.

5 status codes
200Returns the project object, including its ID, name, description, slug, language and permission details, and settings.
avatarobjectoptional
baseLanguageobjectoptional
computedPermissionobjectrequired
defaultNamespaceobjectoptional
descriptionstringoptional
directPermissionobjectoptional
icuPlaceholdersbooleanrequired
Whether to disable ICU placeholder visualization in the editor and it's support.
idintegerrequired
namestringrequired
organizationOwnerobjectoptional
organizationRolestringoptional
Allowed:MEMBEROWNERMAINTAINER
publicbooleanrequired
Whether the project is public — discoverable and open to community suggestions
slugstringoptional
suggestionsModestringrequired
Suggestions for translations
Allowed:DISABLEDENABLED
translationProtectionstringrequired
Level of protection of translations
Allowed:NONEPROTECT_REVIEWED
useBranchingbooleanrequired
useNamespacesbooleanrequired
useQaChecksbooleanrequired
400Returned when the request is malformed or `projectId` 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 cannot access the project.
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 project exists with the given `projectId`.
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 malformed or projectId is invalid. A 401 indicates that the request is not authenticated, and a 403 indicates that the authenticated user cannot access the project. A 404 is returned when the projectId path parameter does not identify an existing project.