Sign in

v1

latestOpenAPI 3.0.32026-07-2415128381.3 KB
Translations

List all translations

Retrieves a list of project translation items, ungrouped. This endpoint supports cursor pagination for better performance with large datasets. When using cursor pagination, the response will include a <code>nextCursor</code> value in the response headers when more data is available. Continue making requests with the <code>nextCursor</code> value until no <code>nextCursor</code> is returned, indicating all data has been retrieved.

You may want to request Keys resource in order to get the structured key/translation pairs for all languages.

Requires <code>read_translations</code> OAuth access scope.

get/projects/{project_id}/translations

Path parameters

project_idstring required

A unique project identifier

Query parameters

disable_referencesnumber

Whether to disable key references. Possible values are <code>1</code> and <code>0</code>.

filter_lang_idnumber

Return translations only for presented language ID.

filter_is_reviewednumber

Filter translations which are reviewed. Possible values are <code>1</code> and <code>0</code>.

filter_unverifiednumber

Filter translations which are unverified. Possible values are <code>1</code> and <code>0</code>.

filter_untranslatednumber

Filter by untranslated keys. Possible values are <code>1</code> and <code>0</code>.

filter_qa_issuesstring

One or more QA issues to filter by (comma separated). Possible values are <code>spelling_and_grammar</code>, <code>placeholders</code>, <code>html</code>, <code>url_count</code>, <code>url</code>, <code>email_count</code>, <code>email</code>, <code>brackets</code>, <code>numbers</code>, <code>leading_whitespace</code>, <code>trailing_whitespace</code>, <code>double_space</code>, <code>special_placeholder</code> and <code>unbalanced_brackets</code>.

filter_active_task_idnumber

Filter translations which are part of given task ID.

pagination'offset' | 'cursor'

Type of pagination. Possible values are <code>offset</code> and <code>cursor</code>. The default value is <code>offset</code>. Cursor pagination is performance-optimized and does not count total records or calculate remaining pages. When using cursor pagination, continue making requests until no <code>nextCursor</code> is returned in the response headers.

limitinteger

Number of items to include (max 5000).

pageinteger

Return results starting from this page.

cursorstring

Return results starting from this cursor. When using cursor pagination, this parameter should contain the <code>nextCursor</code> value from the previous response. Continue pagination until no <code>nextCursor</code> is returned in the response headers.

Response

OK

project_idstring