Skip to main content
GET
/
projects
/
{project_id}
/
keys
/
{id}
cURL
curl "https://api.phrase.com/v2/projects/:project_id/keys/:id?branch=my-feature-branch" \
  -u USERNAME_OR_ACCESS_TOKEN
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "home.index.headline",
  "description": "My description for this key...",
  "name_hash": "1b31d2580ce324f246f66b3be00ed399",
  "plural": false,
  "use_ordinal_rules": 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

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

id
string
required

ID

Query Parameters

branch
string

specify the branch to use

Response

OK

id
string
name
string
description
string
name_hash
string
plural
boolean
use_ordinal_rules
boolean
tags
string[]
data_type
string
created_at
string<date-time>
updated_at
string<date-time>
name_plural
string
comments_count
integer
max_characters_allowed
integer
screenshot_url
string
unformatted
boolean
xml_space_preserve
boolean
original_file
string
format_value_type
string
creator
user_preview · object
Example:

null

custom_metadata
custom_metadata · object