Lists all keys of a branch, ordered by name, with their translation in one language.
HTTP
GET /branches/{branchId}/keysAccess: Session token, or an API key with the projects:read scope.
Role: Any role in the project.
Path parameters #
| Parameter | Description |
|---|---|
branchId | The id of the branch. |
Query parameters #
| Parameter | Required | Description |
|---|---|---|
language | yes | A language code such as de-de, lower case or not. |
Response 200 #
A list of keys.
JSON
[
{
"id": "0197a3c9-7086-7d77-8ace-2e6b8f3d5097",
"name": "checkout.title",
"source": "Checkout",
"maxLength": null,
"translation": { "value": "Kasse", "status": "approved" }
}
]Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the key. |
name | string | The name of the key. |
source | string or null | The source text. null until it has one. |
maxLength | integer or null | The longest allowed translation, in characters, or null for no limit. |
translation | object or null | The translation in the requested language: value and status (draft, review, changes or approved). null when there is none. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The branch does not exist, you have no access to its project, or branchId is not a UUID. |
| 422 | invalid_request | language is missing or not a language code (language: invalid). |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.