Lists the translations of a branch in one language that wait for review or were reviewed recently: all in review or with requested changes, and the ones approved in the last 7 days.
HTTP
GET /branches/{branchId}/reviewAccess: Session token only. API keys get 403 with insufficient_scope.
Role: Project reviewer or manager.
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 entries ordered by key name.
JSON
[
{
"keyId": "0197a3c9-7086-7d77-8ace-2e6b8f3d5097",
"name": "checkout.title",
"source": "Checkout",
"maxLength": null,
"translation": "Kasse",
"state": "pending",
"submittedBy": { "id": "...", "name": "Tina Translator", "email": "tina@example.com", "initials": "TT", "gradient": "...", "from": "#06b6d4", "to": "#7c3aed" },
"ageMinutes": 25,
"note": null
}
]Response fields #
| Field | Type | Description |
|---|---|---|
keyId | string | The id of the key. |
name | string | The name of the key. |
source | string | The source text. |
maxLength | integer or null | The longest allowed translation, in characters, or null for no limit. |
translation | string | The translation. |
state | string | pending (waiting for review), changes (changes requested) or approved. |
submittedBy | object or null | Who submitted it. |
ageMinutes | integer | Minutes since it was submitted. |
note | string or null | The oldest note on the key. |
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. |
| 403 | forbidden | You are a translator in the project. |
| 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.