| Field | Type | Description |
|---|---|---|
| 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 | string or array of objects | 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). Every key_name object has the following attributes:ios (string) — "iOS" platform key name.android (string) — "Android" platform key name.web (string) — "Web" platform key name.other (string) — "Other" platform key name. |
| filenames | array of objects | An object containing key filename attribute for each platform. Every filename has the following attributes:ios (string) — "iOS" platform filename.android (string) — "Android" platform filename.web (string) — "Web" platform filename.other (string) — "Other" platform filename. |
| descripton | string | Description of the key. |
| platforms | array | List of platforms, enabled for this key. |
| tags | array | List of tags for this key. |
| comments | array of objects | Comments for this key. Every comment has the following attributes: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. Every screenshot has the following attributes:screenshot_id (number) — A unique identifier of the screenshot.key_ids (array) — List of key identifiers, the screenshot is attached to.url (string) — Link to the screenshot.title (string) — Screenshot title.description (string) — Description of the screenshot.screenshot_tags (array) — List of 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. Every translation has the following attributes: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 or object) — The actual translation. Contains 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 of objects) — Array consisting of Custom Translation Status objects.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 | string | JSON containing custom attributes (if any). |
| 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. |