Guides
- Getting started
- Authentication
- Pagination
- Usage examples
- Developer Tools
API Documentation
- Accounts
- Authorizations
- Blacklisted Keys
- Branches
- Comment Reactions
- Comment Replies
- Comments
- Custom Metadata
- Distributions
- Documents
- Figma attachments
- Formats
- Glossaries
- Glossary Term Translations
- Glossary Terms
- ICU
- Invitations
- Job Comments
- Job Locales
- Job Template Locales
- Job Templates
- Jobs
- Key's Figma attachments
- Keys
- Linked Keys
- Locale Downloads
- Locales
- Members
- Notification Groups
- Notifications
- Orders
- Organization Job Template Locales
- Organization Job Templates
- Projects
- Quality performance score
- Release Triggers
- Releases
- Repo Sync Events
- Repo Syncs
- Reports
- Screenshot Markers
- Screenshots
- Search
- Spaces
- Style guides
- Tags
- Teams
- Translations
- Uploads
- Users
- Variables
- Versions / History
- Webhook Deliveries
- Webhooks
Search
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
cURL
Copy
Ask AI
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 \
Copy
Ask AI
{
"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
Enter your token in the format token TOKEN
Headers
Two-Factor-Authentication token (optional)
Path Parameters
Account ID
Body
application/json
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
cURL
Copy
Ask AI
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 \
Copy
Ask AI
{
"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"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.