github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/locales/download.yaml

---
summary: Download a locale
description: Download a locale in a specific file format.
operationId: locale/download
tags:
  - Locales
parameters:
  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
  - "$ref": "../../parameters.yaml#/If-Modified-Since"
  - "$ref": "../../parameters.yaml#/If-None-Match"
  - "$ref": "../../parameters.yaml#/project_id"
  - "$ref": "../../parameters.yaml#/locale_id_as_id"
  - description: specify the branch to use
    example: my-feature-branch
    name: branch
    in: query
    schema:
      type: string
  - description: File format name. See the <a href="https://support.phrase.com/hc/en-us/sections/6111343326364">format guide</a> for all supported file formats.
    example: yml
    name: file_format
    in: query
    schema:
      type: string
  - description: Limit results to keys tagged with a list of comma separated tag names.
    example: feature1,feature2
    name: tags
    in: query
    schema:
      type: string
  - description: Limit download to tagged keys. This parameter is deprecated. Please use the "tags" parameter instead
    example: feature
    deprecated: true
    name: tag
    in: query
    schema:
      type: string
  - description: Indicates whether keys without translations should be included in the output as well.
    example:
    name: include_empty_translations
    in: query
    schema:
      type: boolean
  - description: Indicates whether zero forms should be included when empty in pluralized keys.
    example:
    name: exclude_empty_zero_forms
    in: query
    schema:
      type: boolean
  - description: Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
    example:
    name: include_translated_keys
    in: query
    schema:
      type: boolean
  - description: Indicates whether [NOTRANSLATE] tags should be kept.
    example:
    name: keep_notranslate_tags
    in: query
    schema:
      type: boolean
  - description: 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.
    example:
    deprecated: true
    name: convert_emoji
    in: query
    schema:
      type: boolean
  - description: 'Additional formatting and render options. See the <a href="https://support.phrase.com/hc/en-us/sections/6111343326364">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>'
    example:
    name: format_options
    in: query
    schema:
      type: object
      properties: {}
    style: deepObject
    explode: true
  - description: Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1".
    example:
    name: encoding
    in: query
    schema:
      type: string
  - description: Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
    example:
    deprecated: true
    name: skip_unverified_translations
    in: query
    schema:
      type: boolean
  - description: if set to false unverified translations are excluded
    example:
    name: include_unverified_translations
    in: query
    schema:
      type: boolean
  - description: 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.
    example:
    name: use_last_reviewed_version
    in: query
    schema:
      type: boolean
  - description: 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 <code>true</code>.
    example:
    name: fallback_locale_id
    in: query
    schema:
      type: string
  - description: 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 <code>tag</code> parameter indicating a specific job.
    example:
    name: source_locale_id
    in: query
    schema:
      type: string
  - name: custom_metadata_filters
    in: query
    description: |
      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.
    schema:
      type: object
      properties: {}
    style: deepObject
    explode: true
responses:
  "200":
    description: OK
    content:
      "*":
        schema:
          type: string
          format: binary
    headers:
      X-Rate-Limit-Limit:
        "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
      X-Rate-Limit-Remaining:
        "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
      X-Rate-Limit-Reset:
        "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
  "400":
    "$ref": "../../responses.yaml#/400"
  "404":
    "$ref": "../../responses.yaml#/404"
  "429":
    "$ref": "../../responses.yaml#/429"
x-code-samples:
  - lang: Curl
    source: |-
      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
  - lang: CLI v2
    source: |-
      phrase locales download \
      --project_id <project_id> \
      --id <id> \
      --branch my-feature-branch \
      --file_format yml \
      --tags feature1,feature2 \
      --tag feature \
      --access_token <token>
x-cli-version: "2.6.4"