Skip to main content
GET
Get a glossary with its entries
When to use: to read or edit terms. Side effects: None. Cost: Free. Idempotency: safe and pure (never writes); retry freely. Required scopes: glossaries:read

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

glossaries:read

Path Parameters

glossary_id
string
required

Glossary id.

Maximum string length: 64

Response

OK: Glossary.

A glossary for one language pair.

object
enum<string>
required

Always glossary.

Available options:
glossary
id
string
required

Glossary id.

name
string
required

Glossary name.

source_language
string
required

Source language, without a region (en).

target_language
string
required

Target language, without a region (es).

version
integer<int32>
required

Version; every update increments it.

entry_count
integer<int32>
required

Number of entries.

entries
object | null
required

Source term -> target term. Returned by get, create and update; null in lists.

created_at
string<date-time>
required

Creation time.

created_by
object
required

A user reference.