Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Job Locales

List job target locales

List all target locales for a given job.

get/projects/{project_id}/jobs/{job_id}/locales

Path parameters

project_idstring required

Project ID

job_idstring required

Job ID

Query parameters

pageinteger

Page number

per_pageinteger

Limit on the number of objects to be returned, between 1 and 100. 25 by default

branchstring

Branch to use

include_annotationsboolean

Include job-locale annotations in the response

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

idstring
completedboolean
translation_completed_atstring date-time
review_completed_atstring date-time

Example response

[
  {
    "id": "626ea67628690c73ac86ac81eec2d185",
    "job": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "My Job 1",
      "state": "completed"
    },
    "users": [
      {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "username": "joe.doe",
        "name": "Joe Doe",
        "role": "translator"
      }
    ],
    "teams": [
      {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "Joe's team",
        "role": "translator"
      }
    ],
    "locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    },
    "annotations": [
      {
        "name": "priority",
        "value": "high",
        "created_at": "2023-10-01T12:00:00Z",
        "updated_at": "2023-10-01T12:00:00Z"
      }
    ],
    "completed": true,
    "translation_completed_at": "2017-01-28T09:52:53Z",
    "review_completed_at": "2017-01-28T09:52:53Z"
  }
]