list_glossaries

CatalogApi.list_glossaries(role_id, limit=None, offset=None, sortorder=None, sortby=None, filter_expression=None, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List accessible glossaries

Returns the glossaries the caller has access to, with their access level. Terms are omitted from the listing - use the get-by-id operation to retrieve them. Read next_available in the response to know whether another page exists.

Parameters:

  • role_id (str) – User role id (required)

  • limit (int) – Maximum number of glossaries to return in one page.

  • offset (int) – 1-based index of the first glossary to return, so offset=1 is the first page and offset=101 is the second page at the default limit.

  • sortorder (str) – Direction to sort by.

  • sortby (str) – Glossary field to sort by. Must be a text field present on every glossary, such as GlossaryName, Description, GlossaryStatus, CreatedBy, CreatedTime, LastModifiedBy or LastModifiedTime.

  • filter_expression (str) – Filter as one or more Field:Value pairs, comma-separated and combined with AND, for example GlossaryName:sales*,GlossaryStatus:completed. Any field on the item may be used. Matching is case-insensitive; GlossaryName also supports * as a wildcard against the whole value, so use a trailing * for a prefix search. Pairs without a colon are ignored, and a filter with no valid pairs returns everything.

  • projection_expression (str) – Comma-separated list of fields to return; all other fields are omitted from each glossary.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GlossariesList

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /glossaries

Success (HTTP 200)

Successful API response

Request / response example

{
  "Glossaries": [
    {
      "GlossaryId": "3d9a7c14-6b2e-4f80-91ac-5e7d8b3f2a61",
      "GlossaryName": "CustomerMetrics",
      "GlossaryStatus": "completed",
      "Description": "Business terms for customer analytics",
      "CreatedBy": "jdoe",
      "CreatedTime": "2026-07-15 09:30:00",
      "LastModifiedBy": "jdoe",
      "LastModifiedTime": "2026-08-10 14:22:41",
      "AccessType": "owner"
    }
  ],
  "count": 1,
  "total_count": 1,
  "next_available": "no"
}

Errors

Documented error codes: IPV-1050, AUTH-1002, GE-1020.

HTTP 400

Invalid input

limit above the page cap

{
  "Message": "IPV-1050 - Out of range for items per page, Limit is 1000"
}

Role is not allowed to read glossaries

{
  "Message": "AUTH-1002 - User action is not permitted"
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "GE-1020 - Unable to update Glossary table, please retry or contact administrator"
}