Skip to main content
GET
/
projects
/
{project_id}
/
jobs
cURL
curl "https://api.phrase.com/v2/projects/:project_id/jobs?branch=my-feature-branch&owned_by=abcd1234cdef1234abcd1234cdef1234&assigned_to=abcd1234cdef1234abcd1234cdef1234&state=completed" \
  -u USERNAME_OR_ACCESS_TOKEN
[
  {
    "id": "626ea67628690c73ac86ac81eec2d185",
    "name": "Translations for new Feature",
    "briefing": "Some instructions for the translators",
    "due_date": "2017-02-28T09:52:53Z",
    "state": "completed",
    "ticket_url": "https://example.atlassian.net/browse/FOO",
    "created_at": "2017-01-28T09:52:53Z",
    "updated_at": "2017-01-28T09:52:53Z",
    "project": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "My Android Project",
      "main_format": "xml",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-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

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

​
owned_by
string

filter by user owning job

​
assigned_to
string

filter by user assigned to job

​
state
string

filter by state of job; valid states are: draft, in_progress, completed

​
states
string[]

Filter by multiple job states at once. Accepted values are the same as state. When supplied, state is ignored. Rejected with 400 Bad Request if any value is unknown.

​
key_id
string

Filter to jobs that include the translation key identified by this code (matches via the job's tags).

​
updated_since
string

filter by jobs updated since given date

Response

OK

​
id
string
​
name
string
​
briefing
string
​
due_date
string<date-time> | null
​
state
string
​
ticket_url
string
​
project
project_short · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "main_format": "xml",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}
​
branch
branch_name · object
Example:
{ "name": "new-branch" }
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
automation_id
string | null

The ID of the automation that created this job, or null if the job was created manually.

​
job_template_id
string | null

The ID of the job template this job was created from, or null if no template was used.