---
title: "List format annotations for a key"
method: GET
path: "/projects/{project_id}/keys/{id}/format_annotations"
tags: ["Key Format Annotations"]
---

# List format annotations for a key

`GET /projects/{project_id}/keys/{id}/format_annotations`

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.

## Path parameters

- `project_id` string, required
- `id` string, required

## Query parameters

- `branch` string

## Headers

- `X-PhraseApp-OTP` string

## Response `200`

OK

- object[]
  - `file_format` string — The file format that produced this annotation.
  - `original_representation` string — The original file-format snippet captured when the key was imported. Returned as-is, may contain multi-line content.

## Other responses

- `400` — Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.
- `401` — Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.
- `403` — Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.
- `404` — Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.
- `429` — Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.

---

[API](https://skmtc.dev/phrase/apis/control-hub-service.md) · [All operations](https://skmtc.dev/phrase/apis/control-hub-service/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/phrase/control-hub-service/revisions/98ecac7ba2bf/schema)