v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Keys

Get a single key

Get details on a single key for a given project.

get/projects/{project_id}/keys/{id}

Path parameters

project_idstring required

Project ID

idstring required

Query parameters

branchstring

specify the branch to use

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

idstring

namestring

descriptionstring

name_hashstring

pluralboolean

use_ordinal_rulesboolean

tagsstring[]

data_typestring

created_atstring date-time

updated_atstring date-time

name_pluralstring

comments_countinteger

max_characters_allowedinteger

screenshot_urlstring

unformattedboolean

xml_space_preserveboolean

original_filestring

format_value_typestring

custom_metadataobject

Example response

{
  "name_plural": "home.index.headlines",
  "comments_count": 2,
  "data_type": "string",
  "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"
  }
}