Skip to main content
DELETE
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

branch
string

specify the branch to use

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 exact key names - spaces, commas, and colons need to be escaped with double backslashes
  • tags:tag_name to filter for keys with certain tags
  • 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

Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored.

Find more examples here.

locale_id
string

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

Response

OK

records_affected
integer