> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# List Glossary Terms

> List all glossary terms with optional filtering and pagination

# List Glossary Terms

List all glossary terms with optional filtering and pagination.

## Query Parameters

<ParamField query="glossary" type="string">
  Filter by glossary fully qualified name.
</ParamField>

<ParamField query="parent" type="string">
  Filter by parent glossary term fully qualified name.
</ParamField>

<ParamField query="limit" type="integer" default="10">
  Maximum number of results to return (max: 1000000).
</ParamField>

<ParamField query="before" type="string">
  Cursor for backward pagination.
</ParamField>

<ParamField query="after" type="string">
  Cursor for forward pagination.
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include: `owners`, `tags`, `domains`, `relatedTerms`, `reviewers`, `children`. See [Supported Fields](#supported-fields) below.
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

<RequestExample dropdown>
  ```python GET /v1/glossaryTerms theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import GlossaryTerms

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  # List first page
  terms = GlossaryTerms.list(limit=50)
  for t in terms.data:
      print(f"{t.fullyQualifiedName}")

  # List all with auto-pagination
  for t in GlossaryTerms.list_all():
      print(f"{t.fullyQualifiedName}")

  # Filter by glossary with fields
  terms = GlossaryTerms.list(
      glossary="BusinessGlossary",
      fields=["owners", "tags", "relatedTerms", "children"],
      limit=50
  )

  for t in terms.data:
      print(f"{t.fullyQualifiedName}")
      if t.synonyms:
          print(f"  Synonyms: {t.synonyms}")
  ```

  ```java GET /v1/glossaryTerms theme={null}
  import static org.openmetadata.sdk.fluent.GlossaryTerms.*;

  // List first page
  var result = GlossaryTerms.list()
      .limit(50)
      .execute();

  for (var t : result.getData()) {
      System.out.println(t.getFullyQualifiedName());
  }

  // Filter by glossary with fields
  var result = GlossaryTerms.list()
      .glossary("BusinessGlossary")
      .fields("owners", "tags", "relatedTerms", "children")
      .limit(50)
      .execute();
  ```

  ```bash GET /v1/glossaryTerms theme={null}
  # List all
  curl "{base_url}/api/v1/glossaryTerms?limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by glossary
  curl "{base_url}/api/v1/glossaryTerms?glossary=BusinessGlossary&fields=owners,tags,relatedTerms,children&limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by parent term
  curl "{base_url}/api/v1/glossaryTerms?parent=BusinessGlossary.Revenue&limit=50" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": [
      {
        "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
        "name": "Revenue",
        "fullyQualifiedName": "BusinessGlossary.Revenue",
        "displayName": "Revenue",
        "description": "Total income generated from business operations",
        "synonyms": ["Income", "Earnings", "Sales"],
        "glossary": {
          "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
          "type": "glossary",
          "name": "BusinessGlossary",
          "fullyQualifiedName": "BusinessGlossary",
          "deleted": false
        },
        "version": 0.1,
        "updatedAt": 1769984330261,
        "updatedBy": "admin",
        "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
        "deleted": false,
        "owners": [],
        "tags": [],
        "children": [],
        "relatedTerms": []
      }
    ],
    "paging": {
      "after": "...",
      "total": 15
    }
  }
  ```
</ResponseExample>

***

## Returns

Returns a paginated list of glossary term objects. By default, only basic fields are included. Use the `fields` parameter to request additional data.

## Response

<ResponseField name="data" type="array">
  Array of glossary term objects.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Unique identifier for the glossary term (UUID format).
    </ResponseField>

    <ResponseField name="name" type="string">
      Glossary term name.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name of the glossary term.
    </ResponseField>

    <ResponseField name="synonyms" type="array">
      List of synonym strings.
    </ResponseField>

    <ResponseField name="glossary" type="object">
      Reference to the parent glossary.
    </ResponseField>

    <ResponseField name="owners" type="array" optional>
      List of owners. Only included when `fields` contains `owners`.
    </ResponseField>

    <ResponseField name="tags" type="array" optional>
      Classification tags. Only included when `fields` contains `tags`.
    </ResponseField>

    <ResponseField name="children" type="array" optional>
      Child term references. Only included when `fields` contains `children`.
    </ResponseField>

    <ResponseField name="relatedTerms" type="array" optional>
      Related term references. Only included when `fields` contains `relatedTerms`.
    </ResponseField>

    <ResponseField name="reviewers" type="array" optional>
      Reviewers. Only included when `fields` contains `reviewers`.
    </ResponseField>

    <ResponseField name="domains" type="array" optional>
      Domain assignments. Only included when `fields` contains `domains`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="paging" type="object">
  Pagination information.

  <Expandable title="properties">
    <ResponseField name="total" type="integer">
      Total count of glossary terms matching the query.
    </ResponseField>

    <ResponseField name="after" type="string" optional>
      Cursor for the next page of results. Null if this is the last page.
    </ResponseField>

    <ResponseField name="before" type="string" optional>
      Cursor for the previous page of results. Null if this is the first page.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Supported Fields

| Field          | Description                        |
| -------------- | ---------------------------------- |
| `owners`       | Owner references (users and teams) |
| `tags`         | Classification tags                |
| `domains`      | Domain assignments for governance  |
| `relatedTerms` | Related glossary term references   |
| `reviewers`    | Glossary term reviewers            |
| `children`     | Child glossary term references     |

***

## Error Handling

| Code  | Error Type     | Description                                  |
| ----- | -------------- | -------------------------------------------- |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token      |
| `403` | `FORBIDDEN`    | User lacks permission to list glossary terms |