Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Formats

List formats

Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endpoint does not require authentication and is not subject to rate limiting.

get/formats

Response

OK

namestring required

Human-readable display name of the format.

api_namestring required

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

descriptionstring required

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

extensionstring required

Default file extension associated with this format.

default_encodingstring required

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

importableboolean required

Whether locale files can be imported using this format.

exportableboolean required

Whether locale files can be exported using this format.

default_filestring required

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

renders_default_localeboolean required

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

includes_locale_informationboolean required

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

Example response

[
  {
    "name": "Ruby/Rails YAML",
    "api_name": "yml",
    "description": "YAML file format for use with Ruby/Rails applications",
    "extension": "yml",
    "default_encoding": "UTF-8",
    "importable": true,
    "exportable": true,
    "default_file": "./config/locales/<locale_name>.yml",
    "renders_default_locale": false,
    "includes_locale_information": false
  }
]