---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a glossary"
description: "`localization.glossaries.get` (GET /v1/{name}): Gets a glossary."
type: reference
product: localization
summary: "Gets a glossary."
updated: 2026-09-28
nav: false
---

Gets a glossary.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries/glossary`
- **Scope** `localization:read`
- **Effect** `read` — nothing is written.
- **Collection** [glossaries](/docs/api/glossaries)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the glossary to get. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/glossaries/{glossary}`. |
| `uid` | `string` | `gls_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `GlossarySpec` | Desired state. Required. |
| `status` | `GlossaryStatus` | Observed state. 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. |

### GlossarySpec

| Field | Type | What it is |
| --- | --- | --- |
| `terms` | `GlossaryTerm[]` | The terms; at most 5000. |

### GlossaryStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `term_count` | `int32` | The number of terms. Output only. |

### GlossaryTerm

| Field | Type | What it is |
| --- | --- | --- |
| `term` | `string` | The term, as written in the source. Required. |
| `description` | `string` | A note for translators, at most 500 characters. |
| `rule` | `TermRule` | What to do with the term. Required. One of `translate`, `keep`, `forbidden`. |
| `translations` | `map<string, string>` | Locale to the required translation; used by `TERM_RULE_TRANSLATE`. |
| `replacement` | `string` | Suggested wording; used by `TERM_RULE_FORBIDDEN`. |
| `locales` | `string[]` | The locales the term applies to; empty is every locale. |
| `case_sensitive` | `bool` | Match the term's letter case exactly. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries/glossary" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.localization.glossaries.get({ name: 'orgs/acme/projects/shop/envs/production/glossaries/glossary' })
```

**Rust**

```rust
let mut req = sylphx::localization::GetGlossaryRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/glossaries/glossary".to_string();
let response = sx.localization().glossaries().get(req).await?;
```

**CLI**

```bash
sylphx localization glossaries get orgs/acme/projects/shop/envs/production/glossaries/glossary
```

**MCP**

```json
{ "method_id": "localization.glossaries.get", "args": {"name":"orgs/acme/projects/shop/envs/production/glossaries/glossary"} }
```