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

account_id
string
required

Account ID

Body

application/json
query
string

Search query

Example:

"keyword"

locale_code
string

Locale code

Example:

"de_DE"

page
integer

Page

Example:

1

per_page
integer

Number of results per page

Example:

25

project_ids
string[]

Limit the search to the given project codes. When omitted, the search spans every project the user can access in this account.

Example:

Response

OK

query
string
excerpt
string
key
key_preview · object
Example:

null

locale
locale_preview · object
Example:
project
project · object
Example:
translation
translation · object
Example:
other_translations
translation · object[]