Returns one key with its translation, notes, links, screenshots, comments and history for one language.
HTTP
GET /keys/{keyId}Access: Session token, or an API key with the projects:read scope.
Role: Any role in the project.
Path parameters #
| Parameter | Description |
|---|---|
keyId | The id of the key. |
Query parameters #
| Parameter | Required | Description |
|---|---|---|
language | yes | A language code such as de-de, lower case or not. |
Response 200 #
The key.
JSON
{
"id": "0197a3c9-7086-7d77-8ace-2e6b8f3d5097",
"description": "",
"maxLength": null,
"translation": { "value": "Kasse", "status": "approved", "submitted_by": "0197a3c2-5b1e-7c4a-9d2f-3e8b6a1f0c55", "updated_by": "0197a3c2-5b1e-7c4a-9d2f-3e8b6a1f0c55" },
"notes": [ { "id": "...", "person": { ... }, "body": "Button label", "tags": [], "ageMinutes": 60 } ],
"links": [ { "id": "...", "icon": "link", "title": "Design", "url": "https://example.com/design", "description": null } ],
"comments": [ { "id": "...", "person": { ... }, "body": "Shorter?", "role": "Reviewer", "ageMinutes": 30 } ],
"history": [ { "id": "...", "person": { ... }, "action": "approved", "value": "Kasse", "ageMinutes": 10 } ],
"assets": [ { "id": "...", "filename": "cart.png", "mimeType": "image/png", "size": 48210, "createdAt": "2026-10-16T09:44:55+00:00" } ],
"assetsEnabled": true
}Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the key. |
description | string or null | A description for translators. |
maxLength | integer or null | The longest allowed translation, in characters, or null for no limit. |
translation | object or null | value, status, submitted_by and updated_by (user ids), or null when there is no translation. |
notes | list of object | Notes by reviewers: id, person, body, tags, ageMinutes. The newest first. |
links | list of object | Links for translators: id, icon, title, url, description. |
assets | list of object | Screenshots, oldest first: id, filename, mimeType, size, createdAt. The image is at GET /keys/{keyId}/assets/{assetId}. |
assetsEnabled | boolean | Whether the plan of your organisation includes screenshots. |
comments | list of object | Comments on the translation in this language: id, person, body, ageMinutes, and the commenter’s role (Translator, Reviewer or null). The oldest first. |
history | list of object | The last 30 changes of the translation in this language: id, person, action, value, ageMinutes. The newest first. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The key does not exist, you have no access to its project, or keyId is not a UUID. |
| 422 | invalid_request | language is missing or not a language code. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.