Skip to main content
GET
/
projects
/
{project_id}
/
jobs
/
{job_id}
/
locales
cURL
curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales?branch=my-feature-branch" \
  -u USERNAME_OR_ACCESS_TOKEN
[
  {
    "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"
  }
]

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

job_id
string
required

Job ID

Query Parameters

page
integer

Page number

per_page
integer

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

branch
string

Branch to use

include_annotations
boolean
default:false

Include job-locale annotations in the response

Response

OK

id
string
job
job_preview · object
Example:

null

locale
locale_preview · object
Example:
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "English",
"code": "en-GB"
}
users
locale_user_preview · object[]
teams
locale_team_preview · object[]
completed
boolean
translation_completed_at
string<date-time>
review_completed_at
string<date-time>
annotations
job_annotation · object[]