v1
latestOpenAPI 3.0.32026-07-2415128381.3 KBList all keys
Lists all keys in the project. 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.
<b>IMPORTANT:</b> We do not provide a content delivery network for your language files. Do not make a request to this endpoint every time a user visits your website/app. Instead, fetch the results from this endpoint from time to time, store them locally, and serve your visitors with static files/your database content. Alternatively, you may use our File Download endpoint with an Amazon S3/Google CouldStorage integration to automatically upload your language files to a bucket of your choice.
Requires <code>read_keys</code> OAuth access scope.
Path parameters
A unique project identifier
Query parameters
Whether to disable key references. Possible values are <code>1</code> and <code>0</code>.
Whether to include comments. Possible values are <code>1</code> and <code>0</code>.
Whether to include URL to screenshots. Possible values are <code>1</code> and <code>0</code>.
Whether to include translations. Possible values are <code>1</code> and <code>0</code>.
One or more language ID to filter by (comma separated). Will include translations only for listed IDs.
One or more tags to filter by (comma separated).
One or more filenames to filter by (comma separated).
One or more key name to filter by (comma separated). In case "Per-platform keys" is enabled in project settings, the filter will be applied to all platform names.
One or more key identifiers to filter by (comma separated).
One or more platforms to filter by (comma separated). Possible values are <code>ios</code>, <code>android</code>, <code>web</code> and <code>other</code>.
Filter by untranslated keys. Possible values are <code>1</code> and <code>0</code>.
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>.
One archived filter. Possible values are <code>include</code>, <code>exclude</code> and <code>only</code>.
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.
Number of items to include (max 500).
Return results starting from this page.
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