Skip to main content
POST
/
projects
/
{project_id}
/
translations
/
search
cURL
curl "https://api.phrase.com/v2/projects/:project_id/translations/search" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"branch":"my-feature-branch","sort":"updated_at","order":"desc","q":"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center"}' \
  -H 'Content-Type: application/json'
[
  {
    "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"
  }
]

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

Body

application/json
​
branch
string

specify the branch to use

Example:

"my-feature-branch"

​
sort
string

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

Example:

"updated_at"

​
order
string

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

Example:

"desc"

​
q
string

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
  • tags:XYZ for tags on the translation
  • unverified:{true|false} for verification status
  • excluded:{true|false} for exclusion status
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries

Find more examples here.

Example:

"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center"

Response

OK

​
id
string
​
content
string
​
unverified
boolean
​
excluded
boolean
​
plural_suffix
string
​
key
key_preview · object
Example:

null

​
locale
locale_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
placeholders
string[]
​
state
string
​
created_at
string<date-time>
​
updated_at
string<date-time>