Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Response

OK

name
string
required

Human-readable display name of the format.

Example:

"Ruby/Rails YAML"

api_name
string
required

Identifier used to reference this format in API requests, such as the file_format parameter on the uploads and downloads endpoints.

Example:

"yml"

description
string
required

Human-readable summary of the format and its typical use case.

Example:

"YAML file format for use with Ruby/Rails applications"

extension
string
required

Default file extension associated with this format.

Example:

"yml"

default_encoding
string
required

Default character encoding used when reading or writing files in this format.

Example:

"UTF-8"

importable
boolean
required

Whether locale files can be imported using this format.

Example:

true

exportable
boolean
required

Whether locale files can be exported using this format.

Example:

true

default_file
string
required

Conventional file path pattern for this format. Contains locale_name as a placeholder for the locale identifier.

Example:

"./config/locales/<locale_name>.yml"

renders_default_locale
boolean
required

When true, exported files contain the default locale's content for any key that has no translation in the target locale.

Example:

false

includes_locale_information
boolean
required

When true, files in this format embed locale information so Phrase can detect the locale automatically on import.

Example:

false