Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Linked Keys

List child keys of a parent key

Returns the key link record for a parent key, including all child keys associated with it. Key linking lets translation keys share translations — a child key inherits content from its designated parent. Use this endpoint to inspect which keys are linked under a given parent before unlinking them or auditing translation consistency across related keys.

The key identified by id must be designated as a parent key (it must have at least one child key linked to it). Listing the links of a key that is not a parent returns 400.

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

Path parameters

project_idstring required

Project ID

idstring required

Parent Translation Key ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

created_atstring date-time

The timestamp when the link was created.

updated_atstring date-time

The timestamp when the link was last updated.

Example response

{
  "created_at": "2024-03-15T10:22:00Z",
  "updated_at": "2024-03-15T10:22:00Z",
  "created_by": {
    "id": "usr1a2b3c4d5e6f7a8b9c",
    "username": "jane.doe",
    "name": "Jane Doe",
    "gravatar_uid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
  },
  "updated_by": {
    "id": "usr1a2b3c4d5e6f7a8b9c",
    "username": "jane.doe",
    "name": "Jane Doe",
    "gravatar_uid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
  },
  "account": {
    "id": "acct9z8y7x6w5v4u3t2s",
    "name": "Acme Translations",
    "slug": "acme-translations",
    "company": "Acme Corp",
    "created_at": "2023-01-10T08:00:00Z",
    "updated_at": "2023-06-01T12:00:00Z",
    "company_logo_url": "https://example.com/logos/acme.png"
  },
  "parent": {
    "id": "ijkl9012mnop3456ijkl9012",
    "name": "home.hero.title",
    "plural": false,
    "use_ordinal_rules": false,
    "data_type": "string",
    "tags": [
      "ui",
      "homepage"
    ]
  },
  "children": [
    {
      "id": "ijkl9012mnop3456ijkl9012mnop3456",
      "name": "home.hero.title_short",
      "plural": false,
      "use_ordinal_rules": false,
      "data_type": "string",
      "tags": [
        "ui",
        "homepage"
      ]
    },
    {
      "id": "abcd1234efgh5678abcd1234efgh5678",
      "name": "home.hero.title_long",
      "plural": false,
      "use_ordinal_rules": false,
      "data_type": "string",
      "tags": [
        "ui",
        "homepage"
      ]
    }
  ]
}