PHphrase
Translations

List translations by locale

List translations for a specific locale. If you want to download all translations for one locale we recommend to use the locales#download endpoint.

get/projects/{project_id}/locales/{locale_id}/translations

Request

Path parameters

project_idstring required

Project ID

locale_idstring required

Locale ID

Query parameters

pageinteger

Page number

per_pageinteger

Limit on the number of objects to be returned, between 1 and 100. 25 by default

branchstring

specify the branch to use

sortstring

Sort criteria. Can be one of: key_name, created_at, updated_at.

orderstring

Order direction. Can be one of: asc, desc.

qstring

Specify a query to find translations by content (including wildcards).

Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).

The following qualifiers are supported in the query:

  • id:translation_id,... for queries on a comma-separated list of ids
  • unverified:{true|false} for verification status
  • tags:XYZ for tags on the translation
  • excluded:{true|false} for exclusion status
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries

Find more examples here.

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

idstring
contentstring
unverifiedboolean
excludedboolean
plural_suffixstring
placeholdersstring[]
statestring
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "content": "My translation",
    "unverified": false,
    "excluded": false,
    "plural_suffix": "",
    "key": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "home.index.headline",
      "plural": false,
      "use_ordinal_rules": false
    },
    "locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "de",
      "code": "de-DE"
    },
    "placeholders": [
      "%{count}"
    ],
    "state": "translated",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.