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

Select localization key IDs by filter

Returns the IDs of localization keys that match the supplied filters. Combine filters to select keys by language, translation state, names, namespaces, tags, tasks, comments, QA issues, or other key attributes; use filterKeyPattern and related pattern filters to match text. The returned IDs can be used in subsequent key operations.

47 parameters
projectIdintegerrequired
The unique integer identifier of the project whose keys to select.
filterStatearray<string>optional
Filter by translation state using `languageTag,state`; repeat the parameter to provide multiple states or languages. Multiple states for one language use OR, while multiple languages use AND.
languagesarray<string>optional
Languages to include in the results. Repeat the parameter to include multiple languages; values must be unique.
searchstringoptional
Search key names and translation text for this string.
filterKeyNamearray<string>optional
Select keys by name. Repeat the parameter to include multiple names.
filterKeyIdarray<integer>optional
Select keys by ID. Repeat the parameter to include multiple integer IDs.
filterUntranslatedAnybooleanoptional
Select keys missing a translation in any of the returned languages.
filterTranslatedAnybooleanoptional
Select keys with a translation in any language.
filterUntranslatedInLangstringoptional
Select keys missing a translation in this language; the language must also be included in `languages` for the filter to apply.
filterTranslatedInLangstringoptional
Select keys with a translation in this language.
filterAutoTranslatedInLangarray<string>optional
Select keys with translations that were machine-translated in the specified languages.
filterHasScreenshotbooleanoptional
When true, select keys with screenshots.
filterHasNoScreenshotbooleanoptional
When true, select keys without screenshots.
filterHasDescriptionbooleanoptional
When true, select keys with a description.
filterHasNoDescriptionbooleanoptional
When true, select keys without 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 for the default namespace; repeat to include multiple namespaces.
filterNoNamespacearray<string>optional
Select keys not in the specified namespaces. Use an empty string for the default namespace; repeat to include multiple namespaces.
filterKeyPatternarray<string>optional
Select keys whose names match the supplied pattern. `*` matches any sequence, a leading `=` matches the whole value, and a pattern without `*` matches anywhere; matching is case-insensitive and `%` and `_` are literal. Repeat values to require all patterns to match. Each pattern must be non-empty, at most 500 characters, contain at most 5 wildcards, and there can be at most 20 patterns.
filterNoKeyPatternarray<string>optional
Select keys whose names do not match the supplied pattern. Pattern syntax and limits are the same as `filterKeyPattern`; repeat values to require all patterns to match.
filterDescriptionPatternarray<string>optional
Select keys whose descriptions match the supplied pattern; keys without a description never match. Pattern syntax and limits are the same as `filterKeyPattern`; repeat values to require all patterns to match.
filterNoDescriptionPatternarray<string>optional
Select keys whose descriptions do not match the supplied pattern; keys without a description always match. Pattern syntax and limits are the same as `filterKeyPattern`; repeat values to require all patterns to match.
filterNamespacePatternarray<string>optional
Select keys whose namespaces match the supplied pattern; keys in the default namespace never match. Pattern syntax and limits are the same as `filterKeyPattern`; repeat values to require all patterns to match.
filterNoNamespacePatternarray<string>optional
Select keys whose namespaces do not match the supplied pattern; keys in the default namespace always match. Pattern syntax and limits are the same as `filterKeyPattern`; repeat values to require all patterns to match.
filterTranslationPatternarray<string>optional
Select keys with translation text matching `languageTag,pattern`; use `*` as the language tag to match any returned language. The language must be included in `languages`. Pattern syntax and limits are the same as `filterKeyPattern`; repeat values to require all patterns to match.
filterNoTranslationPatternarray<string>optional
Select keys without translation text matching `languageTag,pattern`; use `*` as the language tag to match any returned language. The language must be included in `languages`, and keys with no translation in that language match. Pattern syntax and limits are the same as `filterKeyPattern`; repeat values to require all patterns to match.
filterTagarray<string>optional
Select keys with the specified tags; repeat to provide multiple tags.
filterNoTagarray<string>optional
Select keys without the specified tags; repeat to provide multiple 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 associated with the specified revision IDs.
filterFailedKeysOfJobintegeroptional
Select keys that were not successfully translated by the specified batch job ID.
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`; conditions for different task types use AND, with language matching determined by the selected status. 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 key translations by 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 values to include more combinations. 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 with suggestions in the specified languages.
filterHasNoSuggestionsInLangarray<string>optional
Select keys without suggestions in the specified languages.
branchstringoptional
Select keys from this branch.
filterDeletedByUserIdarray<integer>optional
Filter trashed keys by the IDs of the users who deleted them.

5 status codes
200Returns an object containing `ids`, an array of integer IDs for keys matching the supplied filters.
idsarray<integer>required
400Returned when a filter value is invalid, including an invalid pattern or a translation-pattern language 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 does not have permission 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 does not exist.
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 a filter value is invalid, including a malformed pattern or a translation-pattern language that is not included in languages. A 401 is returned when the request is unauthenticated, a 403 when the authenticated user lacks access, and a 404 when the project does not exist. Pattern values must be non-empty, at most 500 characters, contain no more than 5 wildcards, and be limited to 20 values per pattern parameter.