Skip to main content

Get Glossary

Retrieve glossary details.

Endpoint​

GET /api/v4/glossaries/{id}

Query Parameters​

ParameterTypeDescription
include_entriesstringInclude entries (default: "false")
limitstringLimit number of entries (default: "1000")

Response Type​

type Glossary = {
  id: number;
  name: string;
  description: string | null;
  source_language: string;
  target_language: string;
  entry_count: number;
  is_active: boolean;
  deepl_glossary_id: string | null;
  google_glossary_id: string | null;
  organization_id: number;
  created_at: string;
  last_modified: string;
  entries?: GlossaryEntry[];
};
type GlossaryEntry = {
  id: number;
  source_term: string;
  target_term: string;
};

Notes​

  • Returns glossary details including source and target languages
  • Optionally includes entries array if include_entries=true
  • The limit parameter controls maximum number of entries returned
  • Entries are term mappings between source and target languages