---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Entries"
description: "The `entries` collection of Sylphx Localization: A Catalog Entry is one source message and its translations."
type: reference
product: localization
summary: "A Catalog Entry is one source message and its translations."
updated: 2026-09-28
order: 900
---

A Catalog Entry is one source message and its translations. `:sync` writes it; it is never created directly. Its id is a stable hash of the file and key, assigned by the server.

**Service** Sylphx Localization · **Resource type** `localization.sylphx.com/CatalogEntry` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/catalogs/{catalog}/entries/{entry}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/catalogs/{catalog}/entries/{entry}`. |
| `uid` | `string` | `ent_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `key` | `string` | The source text plus an optional `\|context`, or an id for id-keyed formats. Output only. |
| `file` | `string` | The source file's path within the upload; empty for a single-file catalog. Output only. |
| `source_text` | `string` | The source message, a Unicode MessageFormat 2 pattern. Output only. |
| `context` | `string` | Disambiguates the same text with different meanings. Output only. |
| `description` | `string` | A note for translators. Output only. |
| `max_length` | `int32` | The longest a translation may be, in characters; 0 is no limit. Output only. |
| `source_hash` | `string` | The first 16 lowercase hex characters of the SHA-256 of the UTF-8 source pattern. A translation is stale when its source hash differs. Output only. |
| `state` | `EntryState` | Whether the source still has this message. Output only. One of `active`, `obsolete`. |
| `translations` | `Translation[]` | The translations, one per target locale at most. Output only. |
| `create_time` | `timestamp` | When the entry was first synced. Output only. |
| `update_time` | `timestamp` | When the entry last changed. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/entries#get) | Gets a catalog entry. |
| `GET` | [`list`](/docs/api/entries#list) | Lists catalog entries. The filter is limited to `state`, `locale`, and `qa_state`. |
| `POST` | [`pin_translation`](/docs/api/entries#pin-translation) | Sets the text of one locale as a human override that AI never overwrites. QA runs on the text first; a text with a QA error is rejected with `INVALID_FIELD`, and the problem lists the findings. |
| `POST` | [`unpin_translation`](/docs/api/entries#unpin-translation) | Removes the human override of one locale; the next sync may translate it again. |

## get

Gets a catalog entry.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries/entry` · scope `localization:read` · effect `read` · [Request, response and examples](/docs/api/entries/get)

## list

Lists catalog entries. The filter is limited to `state`, `locale`, and `qa_state`.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries` · scope `localization:read` · effect `read` · paginated · [Request, response and examples](/docs/api/entries/list)

## pin_translation

Sets the text of one locale as a human override that AI never overwrites. QA runs on the text first; a text with a QA error is rejected with `INVALID_FIELD`, and the problem lists the findings.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries/entry:pinTranslation` · scope `localization:write` · effect `write` · [Request, response and examples](/docs/api/entries/pin_translation)

## unpin_translation

Removes the human override of one locale; the next sync may translate it again.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries/entry:unpinTranslation` · scope `localization:write` · effect `write` · [Request, response and examples](/docs/api/entries/unpin_translation)