Skip to main content
POST
/
accounts
/
{account_id}
/
search
cURL
curl "https://api.phrase.com/v2/accounts/:account_id/search" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -F query=keyword \
  -F locale_code=localecode \
  -F page=1 \
  -F per_page=25 \
{
  "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"
      }
    }
  ]
}

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:
["abcd1234abcd1234abcd1234abcd1234"]

Response

OK

​
query
string
​
excerpt
string
​
key
key_preview · object
Example:

null

​
locale
locale_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
project
project · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "slug": "android_project",
  "main_format": "xml",
  "project_image_url": "http://assets.example.com/project.png",
  "account": "account",
  "space": "space",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}
​
translation
translation · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "content": "My translation",
  "unverified": false,
  "excluded": false,
  "plural_suffix": "",
  "key": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "home.index.headline",
    "plural": false,
    "use_ordinal_rules": false
  },
  "locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "de",
    "code": "de-DE"
  },
  "placeholders": ["%{count}"],
  "state": "translated",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}
​
other_translations
translation · object[]