v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Search across projects

Search for keys and translations in all account projects

Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.

post/accounts/{account_id}/search

Path parameters

account_idstring required

Account ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

querystring

Search query

locale_codestring

Locale code

pageinteger

Page

per_pageinteger

Number of results per page

project_idsstring[]

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

Example request

{
  "query": "keyword",
  "locale_code": "de_DE",
  "page": 1,
  "per_page": 25,
  "project_ids": [
    "abcd1234abcd1234abcd1234abcd1234"
  ]
}

Response

querystring

excerptstring

Example response

{
  "query": "keyword",
  "excerpt": "excerpt text",
  "key": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "key.name",
    "plural": false,
    "data_type": "string",
    "tags": [
      "tag 1",
      "tag 2"
    ]
  },
  "locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "German",
    "code": "de_DE"
  },
  "project": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "project name",
    "slug": "project-slug",
    "main_format": "",
    "project_image_url": "",
    "created_at": "2021-05-04T14:16:26Z",
    "updated_at": "2021-06-14T14:26:09Z",
    "account": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "account name",
      "slug": "account-slug",
      "company": "company name",
      "created_at": "2021-04-27T14:27:25Z",
      "updated_at": "2021-06-14T14:35:15Z",
      "company_logo_url": ""
    },
    "space": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "space name",
      "slug": "space-slug",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z",
      "projects_count": 1
    }
  },
  "translation": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "content": "some content",
    "unverified": true,
    "excluded": false,
    "plural_suffix": "",
    "key": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "key.name",
      "plural": false,
      "data_type": "string",
      "tags": [
        "tag 1",
        "tag 2"
      ]
    },
    "created_at": "2021-05-04T14:17:04Z",
    "updated_at": "2021-05-04T14:17:04Z",
    "placeholders": [],
    "state": "translated",
    "locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "German",
      "code": "de_DE"
    }
  },
  "other_translations": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "content": "some content",
      "unverified": true,
      "excluded": false,
      "plural_suffix": "",
      "key": {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "key.name",
        "plural": false,
        "data_type": "string",
        "tags": [
          "tag 1",
          "tag 2"
        ]
      },
      "created_at": "2021-05-04T14:17:04Z",
      "updated_at": "2021-05-04T14:17:04Z",
      "placeholders": [],
      "state\"": "translated",
      "locale": {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "English",
        "code": "en_EN"
      }
    }
  ]
}