Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Locale Downloads

Show status of an async locale download

Show status of already started async locale download. If the download is finished, the download link will be returned.

get/projects/{project_id}/locales/{locale_id}/downloads/{id}

Path parameters

project_idstring required

Project ID

locale_idstring required

Locale ID

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

If-Modified-Sincestring

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

If-None-Matchstring

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

Response

OK

idstring
status'processing' | 'completed' | 'error'

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

errorstring
created_atstring date-time
completed_atstring date-time

Example response

{
  "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"
}