Skip to main content
POST
cURL

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 by field. Can be one of: 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 do broad search for keys by name (including wildcards).

The following qualifiers are also supported in the search term:

  • ids:key_id,... for queries on a comma-separated list of ids
  • name:key_name,... for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes
  • tags:tag_name,... to filter for keys with certain comma-seperated list of tags
  • uploads:upload_id,... to filter for keys with certain comma-seperated list of uploads
  • job:{true|false} to filter for keys mentioned in an active job
  • translated:{true|false} for translation status (also requires locale_id to be specified)
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
  • unmentioned_in_upload:upload_id,... to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in all uploads

Find more examples here. Please note: If tags are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.

Example:

"mykey* translated:true"

locale_id
string

Locale used to determine the translation state of a key when filtering for untranslated or translated keys.

Example:

"abcd1234abcd1234abcd1234abcd1234"

Response

OK

id
string
name
string
description
string
name_hash
string
plural
boolean
use_ordinal_rules
boolean
tags
string[]
data_type
string
created_at
string<date-time>
updated_at
string<date-time>