Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List entries
Lists catalog entries.
Lists catalog entries. The filter is limited to state, locale, and qa_state.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries - Scope
localization:read - Effect
read— nothing is written. - Collection entries
- Query
page_size,page_token,filter - Pagination the answer carries
catalog_entriesand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The catalog to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter, limited to state, locale, and qa_state; for example state = ENTRY_STATE_ACTIVE AND locale = "ja" AND qa_state = QA_STATE_FAILED. |
#Response
| Field | Type | What it is |
|---|---|---|
catalog_entries | CatalogEntry[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#CatalogEntry
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Translation
| Field | Type | What it is |
|---|---|---|
locale | string | The target locale. Output only. |
text | string | The translated message, a Unicode MessageFormat 2 pattern. Output only. |
origin | TranslationOrigin | Where the text came from. Output only. One of ai, memory, human, imported. |
pinned | bool | A human override that AI never overwrites. Output only. |
stale | bool | The source changed since this text was made. Output only. |
qa_state | QaState | The result of QA on the text. Output only. One of passed, warning, failed, pending. |
findings | QaFinding[] | What QA found. Output only. |
update_time | timestamp | When the text last changed. Output only. |
#QaFinding
| Field | Type | What it is |
|---|---|---|
entry | string | The Catalog Entry, as a resource name. Output only. |
key | string | The entry's key. Output only. |
locale | string | The target locale. Output only. |
check | QaCheck | The check that found it. Output only. One of syntax, placeholders, markup, plural, length, glossary, forbidden_term. |
severity | QaSeverity | How serious it is. Output only. One of error, warning. |
message | string | What is wrong. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries" \
-H "Authorization: Bearer $SYLPHX_API_KEY"