---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Glossaries"
description: "The `glossaries` collection of Sylphx Localization: A Glossary is the terms shared by the catalogs that name it, one per brand or product family."
type: reference
product: localization
summary: "A Glossary is the terms shared by the catalogs that name it, one per brand or product family."
updated: 2026-09-28
order: 900
---

A Glossary is the terms shared by the catalogs that name it, one per brand or product family.

**Service** Sylphx Localization · **Resource type** `localization.sylphx.com/Glossary` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/glossaries/{glossary}` · **Shape** `spec_status`

## Fields

| 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. |

## 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/glossaries#get) | Gets a glossary. |
| `GET` | [`list`](/docs/api/glossaries#list) | Lists glossarys. |
| `POST` | [`create`](/docs/api/glossaries#create) | Creates a glossary. |
| `PATCH` | [`update`](/docs/api/glossaries#update) | Updates a glossary. |
| `DELETE` | [`delete`](/docs/api/glossaries#delete) | Deletes a glossary. |

## get

Gets a glossary.

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

## list

Lists glossarys.

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

## create

Creates a glossary.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries` · scope `localization:write` · effect `write` · [Request, response and examples](/docs/api/glossaries/create)

## update

Updates a glossary.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries/glossary` · scope `localization:write` · effect `write` · [Request, response and examples](/docs/api/glossaries/update)

## delete

Deletes a glossary.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries/glossary` · scope `localization:write` · effect `destructive` · [Request, response and examples](/docs/api/glossaries/delete)