Skip to main content
GET
/
projects
/
{project_id}
/
locales
/
{locale_id}
/
downloads
/
{id}
cURL
curl "https://api.phrase.com/v2/projects/:project_id/locales/:locale_id/downloads/:id" \
  -u USERNAME_OR_ACCESS_TOKEN
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "status": "completed",
  "result": {
    "url": "https://example.com/locales/abcd1234cdef1234abcd1234cdef1234/download?file_format=yml"
  },
  "params": {
    "file_format": "yml",
    "locale_id": "abcd1234cdef1234abcd1234cdef1234",
    "tags": "feature1,feature2",
    "branch": "my-feature-branch",
    "include_empty_translations": true,
    "include_translated_keys": true,
    "include_unverified_translations": true
  },
  "created_at": "2015-01-28T09:52:53Z",
  "completed_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)

​
If-Modified-Since
string

Last modified condition, see Conditional GET requests / HTTP Caching (optional)

​
If-None-Match
string

ETag condition, see Conditional GET requests / HTTP Caching (optional)

Path Parameters

​
project_id
string
required

Project ID

​
locale_id
string
required

Locale ID

​
id
string
required

ID

Response

OK

​
id
string
​
status
enum<string>

The status of the download request. Possible values are processing, completed, and error.

Available options:
processing,
completed,
error
​
result
object
​
params
object

The parameters of the download request.

​
error
string
​
created_at
string<date-time>
​
completed_at
string<date-time>