v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Key Format Annotations

List format annotations for a key

Returns the format annotations stored on a translation key. Format annotations capture file-format data recorded when the key was imported — for example, an ARB placeholder block or an XLIFF note.

Results are limited to 1,000 entries.

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

Path parameters

project_idstring required

Project ID

idstring required

Query parameters

branchstring

Branch to use

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

file_formatstring

The file format that produced this annotation.

original_representationstring

The original file-format snippet captured when the key was imported. Returned as-is, may contain multi-line content.

Example response

[
  {
    "file_format": "xliff_2",
    "original_representation": "<note category=\"meaning\">header</note>"
  }
]