List all keys

get https://api.lokalise.com/api2/projects/{project_id}/keys

Lists all keys in the project. IMPORTANT: We do not provide a content delivery network for your language files. Do not engage a request to this endpoint with every your website/app visitor. Instead, fetch this endpoint from time to time, store the result locally and serve your visitors with static files/your database content. Alternatively, you may use our Amazon S3/Google CouldStorage integrations in automatically upload your language files to a bucket of your choice.

Requires read_keys OAuth access scope.

Path Params

project_id

string

required

A unique project identifier

Query Params

disable_references

number

Whether to disable key references. Possible values are 1 and 0.

include_comments

number

Whether to include comments. Possible values are 1 and 0.

include_screenshots

number

Whether to include URL to screenshots. Possible values are 1 and 0.

include_translations

number

Whether to include translations. Possible values are 1 and 0.

filter_translation_lang_ids

string

One or more language ID to filter by (comma separated). Will include translations only for listed IDs.

filter_tags

string

One or more tags to filter by (comma separated).

filter_filenames

string

One or more filenames to filter by (comma separated).

filter_keys

string

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.

filter_key_ids

string

One or more key identifiers to filter by (comma separated).

filter_platforms

string

One or more platforms to filter by (comma separated). Possible values are ios, android, web and other.

filter_untranslated

number

Filter by untranslated keys. Possible values are 1 and 0.

filter_qa_issues

string

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

filter_archived

string

One archived filter. Possible values are include, exclude and only.

pagination

string

Type of pagination. Possible values are offset and cursor. The default value is offset.

limit

integer

Number of items to include (max 500).

page

integer

Return results starting from this page.

cursor

string

Return results starting from this cursor.

Response

Response body

object

project_id

string

keys

array of objects

keys

object

key_id

number

A unique identifier of the key.

created_at

string

Creation date of the key.

created_at_timestamp

number

Unix timestamp when the key was created.

key_name

object

An object containing key names for all platforms. You may need to enable "Per-platform key names" in project settings in order to alter key names for each platform individually. Note, when creating/updating keys, depending on your project settings (Per-platform key names) you may be required to pass either a string (if the setting is disabled) or an object (if the setting is enabled).

filenames

object

An object containing key filename attribute for each platform.

description

string

Description of the key.

platforms

array

List of platforms, enabled for this key.

platforms

tags

comments

array of objects

Comments for this key.

comments

object

comment_id

number

Unique identifier of the comment.

comment

string

The comment.

added_by

number

Unique identifier of a user, who has left the comment.

added_by_email

string

E-mail of a user, who has left the comment.

added_at

string

Date the comment has been added.

added_at_timestamp

number

Unix timestamp when the comment has been added.

screenshots

array of objects

Screenshots, attached to this key.

screenshots

object

screenshot_id

number

A unique identifier of the screenshot.

key_ids

array

List of key identifiers, the screenshot is attached to.

key_ids

url

string

Link to the screenshot.

title

string

Screenshot title.

description

string

Description of the screenshot.

screenshot_tags

array

List of screenshot tags.

screenshot_tags

width

number

Width of the screenshot, in pixels.

height

number

Height of the screenshot, in pixels.

created_at

string

Creation date of the screenshot.

created_at_timestamp

number

Unix timestamp when the screenshot was created.

translations

array of objects

Translations for all languages.

translations

object

translation_id

number

Unique identifier of translation entry.

key_id

number

A unique identifier of the key.

language_iso

string

Unique code of the language of the translation.

translation

string

The actual translation. Pass as an object, in case it includes plural forms and is_plural is true.

modified_by

number

Identifier of a user, who has updated the translation.

modified_by_email

string

E-mail of a user, who has updated the translation.

modified_at

string

Date of last modification of the translation.

modified_at_timestamp

number

Unix timestamp of last modification of the translation.

is_reviewed

boolean

Whether the translation is marked as Reviewed.

is_unverified

boolean

Whether the translation is marked as Unverified.

reviewed_by

number

Identifier of the user, who has reviewed the translation (if reviewed).

words

number

Number of words in the translation.

custom_translation_statuses

array

Array consisting of Custom Translation Status objects.

custom_translation_statuses

task_id

number

Identifier of the task, if the key is a part of one, or null if it's not.

is_plural

boolean

Whether this key is plural.

plural_name

string

Optional custom plural name (used in some formats).

is_hidden

boolean

Whether this key is hidden from non-admins (translators).

is_archived

boolean

Whether this key is archived.

context

string

Optional context of the key (used with some file formats).

base_words

number

Number of words in base language.

char_limit

number

Maximum allowed number of characters in translations for this key.

custom_attributes

array

JSON containing custom attributes (if any).

custom_attributes

modified_at

string

Date of the latest key update (including screenshots and comments).

modified_at_timestamp

number

Unix timestamp of the latest key update (including screenshots and comments).

translations_modified_at

string

Date of the latest key translation update.

translations_modified_at_timestamp

number

Unix timestamp of the latest key translation update.

Headers

object

X-Total-Count

string

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.lokalise.com/api2/projects/project_id/keys \
3
     --header 'accept: application/json'


xxxxxxxxxx
91
}
1
{
2
  "project_id": "string",
3
  "keys": [
4
    {
5
      "key_id": 0,
6
      "created_at": "string",
7
      "created_at_timestamp": 0,
8
      "key_name": {
9
        "ios": "string",
10
        "android": "string",
11
        "web": "string",
12
        "other": "string"
13
      },
14
      "filenames": {
15
        "ios": "string",
16
        "android": "string",
17
        "web": "string",
18
        "other": "string"
19
      },
20
      "description": "string",
21
      "platforms": [
22
        null
23
      ],
24
      "tags": [
25
        null

200OK