Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Keys

Search keys

Search keys for the given project matching query.

post/projects/{project_id}/keys/search

Path parameters

project_idstring required

Project ID

Query parameters

pageinteger

Page number

per_pageinteger

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

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

sortstring

Sort by field. Can be one of: name, created_at, updated_at.

orderstring

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

qstring

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.

locale_idstring

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

Example request

{
  "branch": "my-feature-branch",
  "sort": "updated_at",
  "order": "desc",
  "q": "mykey* translated:true",
  "locale_id": "abcd1234abcd1234abcd1234abcd1234"
}

Response

OK

idstring
namestring
descriptionstring
name_hashstring
pluralboolean
use_ordinal_rulesboolean
tagsstring[]
data_typestring
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "home.index.headline",
    "description": "My description for this key...",
    "name_hash": "1b31d2580ce324f246f66b3be00ed399",
    "plural": false,
    "use_ordinal_rules": false,
    "tags": [
      "awesome-feature",
      "needs-proofreading"
    ],
    "data_type": "string",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  }
]