Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Translations

Include translations by query

Include translations matching query in locale export.

patch/projects/{project_id}/translations/include

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

qstring

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.

sortstring

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

orderstring

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

Example request

{
  "branch": "my-feature-branch",
  "q": "PhraseApp*%20verified:true%20tags:feature,center",
  "sort": "updated_at",
  "order": "desc"
}

Response

OK

records_affectedinteger

Example response

{
  "records_affected": 96
}