Finds approved translations of similar source text in the projects you can see, the best match first. Without q it returns the most used entries.
HTTP
GET /tmAccess: Session token only. API keys get 403 with insufficient_scope.
Query parameters #
| Parameter | Required | Description |
|---|---|---|
language | yes | The language code of the translations, such as de-de. |
q | no | The source text to match. With it, entries must be at least 30% similar unless you set minPct. |
projectId | no | Only entries of this project. |
limit | no | How many entries, 1 to 50. Default 30. |
minPct | no | Minimum similarity, 0 to 100. Default 30 with q, otherwise 0. |
excludeKey | no | Leave out the entry of this key name. Needs excludeProject. |
excludeProject | no | The project of excludeKey. |
Response 200 #
A list of entries. Empty when you can see no project.
JSON
[
{
"id": "0197a3cb-92a8-7f99-8cef-4a8dab5f7219",
"pct": 100,
"key": "checkout.title",
"source": "Checkout",
"target": "Kasse",
"projectId": "0197a3c6-4d53-7a44-87fb-9b3e5c0a2d64",
"project": "Shop",
"branch": "main",
"approvedBy": "Rex Reviewer",
"ageMinutes": 1440,
"used": 3,
"icu": null
}
]Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the entry. |
pct | integer | How similar the source is to q, 0 to 100. 0 when there is no q. |
key | string | The key it came from. |
source | string | The source text. |
target | string | The approved translation. |
projectId | string | The project it came from. |
project | string | The name of that project. |
branch | string | The branch it came from. |
approvedBy | string or null | Who approved it. |
ageMinutes | integer | Minutes since the entry changed. |
used | integer | How often it was reused. |
icu | string or null | The first {placeholder} in the source, if any. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.