Skip to main content
GET
/
projects
/
{project_id}
/
locales
cURL
curl "https://api.phrase.com/v2/projects/:project_id/locales?branch=my-feature-branch" \
  -u USERNAME_OR_ACCESS_TOKEN
[
  {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "de",
    "code": "de-DE",
    "default": true,
    "main": false,
    "rtl": false,
    "plural_forms": [
      "zero",
      "one",
      "other"
    ],
    "ordinal_plural_forms": [
      "zero",
      "other"
    ],
    "source_locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "en",
      "code": "en-GB"
    },
    "fallback_locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "en",
      "code": "en-GB"
    },
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  }
]

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
project_id
string
required

Project ID

Query Parameters

​
page
integer

Page number

​
per_page
integer

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

​
sort_by
string

Sort locales. Valid options are "name_asc", "name_desc", "default_asc", "default_desc".

​
branch
string

specify the branch to use

​
q
string

Specify a query to filter locales. Currently supports name argument, filtering only locales with names starting with the given string.

Response

OK

​
id
string
​
name
string
​
code
string
​
default
boolean
​
main
boolean
​
rtl
boolean
​
plural_forms
string[]
​
ordinal_plural_forms
string[]
​
source_locale
locale_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
fallback_locale
locale_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
created_at
string<date-time>
​
updated_at
string<date-time>