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
Keys
Get a single key
Get details on a single key for a given project.
GET
/
projects
/
{project_id}
/
keys
/
{id}
cURL
Copy
Ask AI
curl "https://api.phrase.com/v2/projects/:project_id/keys/:id?branch=my-feature-branch" \
-u USERNAME_OR_ACCESS_TOKEN
Copy
Ask AI
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "home.index.headline",
"description": "My description for this key...",
"name_hash": "1b31d2580ce324f246f66b3be00ed399",
"plural": false,
"tags": [
"awesome-feature",
"needs-proofreading"
],
"data_type": "string",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"name_plural": "home.index.headlines",
"comments_count": 2,
"max_characters_allowed": 140,
"screenshot_url": "http://assets.example.com/screenshot.png",
"unformatted": false,
"xml_space_preserve": false,
"original_file": "",
"format_value_type": "",
"creator": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"username": "joe.doe",
"name": "Joe Doe"
},
"custom_metadata": {
"fruit": "Apple",
"vegetable": "Tomato"
}
}
Authorizations
Enter your token in the format token TOKEN
Headers
Two-Factor-Authentication token (optional)
Query Parameters
specify the branch to use
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/projects/:project_id/keys/:id?branch=my-feature-branch" \
-u USERNAME_OR_ACCESS_TOKEN
Copy
Ask AI
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "home.index.headline",
"description": "My description for this key...",
"name_hash": "1b31d2580ce324f246f66b3be00ed399",
"plural": false,
"tags": [
"awesome-feature",
"needs-proofreading"
],
"data_type": "string",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"name_plural": "home.index.headlines",
"comments_count": 2,
"max_characters_allowed": 140,
"screenshot_url": "http://assets.example.com/screenshot.png",
"unformatted": false,
"xml_space_preserve": false,
"original_file": "",
"format_value_type": "",
"creator": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"username": "joe.doe",
"name": "Joe Doe"
},
"custom_metadata": {
"fruit": "Apple",
"vegetable": "Tomato"
}
}
Assistant
Responses are generated using AI and may contain mistakes.