GET
/
projects
/
{project_id}
/
locales
/
{id}
/
download
cURL
curl "https://api.phrase.com/v2/projects/:project_id/locales/:id/download?branch=my-feature-branch&file_format=yml&tags=feature1,feature2&tag=feature&custom_metadata_filters[tone]=friendly" \
  -u USERNAME_OR_ACCESS_TOKEN
This response does not have an example.

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

​
id
string
required

Locale ID or locale name

Query Parameters

​
branch
string

specify the branch to use

​
file_format
string

File format name. See the format guide for all supported file formats.

​
tags
string

Limit results to keys tagged with a list of comma separated tag names.

​
tag
string
deprecated

Limit download to tagged keys. This parameter is deprecated. Please use the "tags" parameter instead

​
include_empty_translations
boolean

Indicates whether keys without translations should be included in the output as well.

​
exclude_empty_zero_forms
boolean

Indicates whether zero forms should be included when empty in pluralized keys.

​
include_translated_keys
boolean

Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.

​
keep_notranslate_tags
boolean

Indicates whether [NOTRANSLATE] tags should be kept.

​
convert_emoji
boolean
deprecated

This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.

​
format_options
object

Additional formatting and render options. See the format guide for a list of options available for each format. Specify format options like this: ...&format_options[foo]=bar

​
encoding
string

Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1".

​
skip_unverified_translations
boolean
deprecated

Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with include_unverified_translations.

​
include_unverified_translations
boolean

if set to false unverified translations are excluded

​
use_last_reviewed_version
boolean

If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.

​
fallback_locale_id
string

If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true.

​
source_locale_id
string

Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a tag parameter indicating a specific job.

​
translation_key_prefix
string

Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.

​
filter_by_prefix
boolean

Only download translation keys containing the specified prefix, and remove the prefix from the generated file.

​
custom_metadata_filters
object

Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.

​
locale_ids
string[]

Locale IDs or locale names

​
updated_since
string

Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., 2023-01-01T00:00:00Z).

Response

200
*

OK

The response is of type file.