Skip to main content
POST
Get the glossary entries and application mode for a source language. Team members have read access to the owner’s glossary.

Authentication and permissions

string
required
Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint.
Required permissions: glossary:read. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

string
required
Text value.Minimum length: 2. Maximum length: 64.
The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. Returns the source language’s glossary settings and public entry rules.

Result fields

Operation notes

  • An unknown glossary for a supported source language returns its calculated glossaryId with no entries.
  • Only the owner can edit the glossary. Team members have read access.

Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation’s own generation allowances also apply.

Errors