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

List project translations

Lists project keys and their translations, with filters for languages, translation state, key metadata, tasks, comments, labels, suggestions, and QA issues. Use cursor to continue through results and page and size to request a page; set languages to control which languages are returned. Combine filters to narrow the keys included in the response.

52 parameters
projectIdintegerrequired
The numeric identifier of the project whose keys and translations to retrieve.
cursorstringoptional
Cursor used to retrieve the next set of results.
includeQaIssuesbooleanoptional
Whether to include detailed QA issues for inline highlighting.
filterStatearray<string>optional
Filter by translation state using `languageTag,state`; repeat this parameter for multiple conditions. Multiple states for one language are combined with OR, and conditions for different languages are combined with AND.
languagesarray<string>optional
Languages to include in the response. Repeat this parameter to request multiple languages; duplicate values are not allowed.
searchstringoptional
Search text matched against key names or translation text.
filterKeyNamearray<string>optional
Select keys by name. Repeat this parameter to include more key names.
filterKeyIdarray<integer>optional
Select keys by numeric identifier. Repeat this parameter to include more identifiers.
filterUntranslatedAnybooleanoptional
When true, select keys missing a translation in any returned language.
filterTranslatedAnybooleanoptional
When true, select keys with a translation in any language.
filterUntranslatedInLangstringoptional
Select keys missing a translation in this language; the language must be included in the response.
filterTranslatedInLangstringoptional
Select keys with a translation in this language.
filterAutoTranslatedInLangarray<string>optional
Select keys that were machine-translated in the specified languages.
filterHasScreenshotbooleanoptional
When true, select keys that have screenshots.
filterHasNoScreenshotbooleanoptional
When true, select keys that do not have screenshots.
filterHasDescriptionbooleanoptional
When true, select keys that have a description.
filterHasNoDescriptionbooleanoptional
When true, select keys that do not have a description.
filterIsPluralbooleanoptional
When true, select plural keys.
filterIsNotPluralbooleanoptional
When true, select non-plural keys.
filterNamespacearray<string>optional
Select keys in the specified namespaces. Use an empty string to select the default namespace.
filterNoNamespacearray<string>optional
Select keys not in the specified namespaces. Use an empty string to filter the default namespace.
filterKeyPatternarray<string>optional
Select keys whose names match the supplied pattern. Matching is case-insensitive; `*` matches any sequence, a leading `=` matches the whole value, and `%` and `_` are literal. Repeat to require all patterns to match.
filterNoKeyPatternarray<string>optional
Select keys whose names do not match the supplied pattern. Matching is case-insensitive; `*` matches any sequence, a leading `=` matches the whole value, and `%` and `_` are literal. Repeat to require all patterns to match.
filterDescriptionPatternarray<string>optional
Select keys whose descriptions match the supplied pattern; keys without descriptions do not match. Pattern matching is case-insensitive, with `*` matching any sequence and a leading `=` matching the whole value.
filterNoDescriptionPatternarray<string>optional
Select keys whose descriptions do not match the supplied pattern; keys without descriptions match. Pattern matching is case-insensitive, with `*` matching any sequence and a leading `=` matching the whole value.
filterNamespacePatternarray<string>optional
Select keys whose namespace matches the supplied pattern; keys in the default namespace do not match. Pattern matching is case-insensitive, with `*` matching any sequence and a leading `=` matching the whole value.
filterNoNamespacePatternarray<string>optional
Select keys whose namespace does not match the supplied pattern; keys in the default namespace match. Pattern matching is case-insensitive, with `*` matching any sequence and a leading `=` matching the whole value.
filterTranslationPatternarray<string>optional
Select keys with a translation matching `languageTag,pattern`; use `*` as the language tag to match any returned language. The language must be included in the returned languages. Pattern matching is case-insensitive, with `*` matching any sequence and a leading `=` matching the whole value.
filterNoTranslationPatternarray<string>optional
Select keys without a translation matching `languageTag,pattern`; use `*` as the language tag to match any returned language. The language must be included in the returned languages, and keys without a translation in the specified language match. Pattern matching is case-insensitive, with `*` matching any sequence and a leading `=` matching the whole value.
filterTagarray<string>optional
Select keys with the specified tags.
filterNoTagarray<string>optional
Select keys without the specified tags.
filterOutdatedLanguagearray<string>optional
Select keys whose translations are outdated in the specified languages.
filterNotOutdatedLanguagearray<string>optional
Select keys whose translations are not outdated in the specified languages.
filterRevisionIdarray<integer>optional
Select keys affected by activity with the specified revision identifiers.
filterFailedKeysOfJobintegeroptional
Select keys that were not successfully translated by the specified batch job.
filterTaskNumberarray<integer>optional
Select keys included in the specified task numbers.
filterTaskKeysNotDonebooleanoptional
When true, select task keys that are not done.
filterTaskKeysDonebooleanoptional
When true, select task keys that are done.
filterTaskInLangarray<string>optional
Filter task membership using `languageTag,taskType,status`. Status must be IN_OPEN_TASK, NOT_IN_OPEN_TASK, HAS_BEEN_IN_TASK, or NEVER_IN_TASK; an open task is NEW or IN_PROGRESS. Conditions for different task types use AND, and this filter does not affect `filterTaskNumber`.
filterHasUnresolvedCommentsInLangarray<string>optional
Select keys with unresolved comments in the specified languages.
filterHasCommentsInLangarray<string>optional
Select keys with any comments in the specified languages.
filterLabelarray<string>optional
Filter keys by translation labels.
filterHasQaIssuesInLangarray<string>optional
Select keys with open QA issues in the specified languages.
filterQaCheckTypearray<string>optional
Filter by QA check type using `languageTag,checkType`; repeat this parameter for multiple conditions. A key matches if any selected check type is present in any selected language.
filterQaChecksStaleInLangarray<string>optional
Select keys with at least one translation whose QA checks are stale in the specified languages.
filterHasSuggestionsInLangarray<string>optional
Select keys that have suggestions in the specified languages.
filterHasNoSuggestionsInLangarray<string>optional
Select keys that have no suggestions in the specified languages.
branchstringoptional
Select keys from the specified branch.
filterDeletedByUserIdarray<integer>optional
Filter trashed keys by the identifiers of the users who deleted them.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted and must be 0 or greater.
Default:0
sizeintegeroptional
Number of results per page. Defaults to 20 when omitted and must be at least 1.
Default:20
sortarray<string>optional
Sort by one or more properties using `property,(asc|desc)`. Defaults to ascending order when a direction is not specified.

5 status codes
200Returns a page of project keys and translation data, including selected language details and pagination information. The response can include a `nextCursor` for retrieving more results.
_embeddedobjectoptional
nextCursorstringoptional
Cursor to get next data
pageobjectoptional
pagedModelobjectoptional
selectedLanguagesarray<object>required
Provided languages data
400Returned when a filter or pagination value is invalid, including a pattern that violates its length, wildcard, or count limits, or a translation-pattern language that is not included in the returned languages.
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 the authenticated user is not permitted to 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 the project 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 for invalid filters, a 401 when the request is unauthenticated, a 403 when the authenticated user cannot access the project, and a 404 when the project is not found. Pattern filters must not be empty, exceed 500 characters, contain more than 5 wildcards, or provide more than 20 patterns; translation-pattern language tags must also be included in the returned languages. The projectId path parameter must identify the project, and page must be at least 0 while size must be at least 1.