---
title: "Get Glossary"
method: GET
path: "/api/glossary/v1/glossaries/name/{glossaryName}"
tags: ["Glossaries"]
---

# Get Glossary

`GET /api/glossary/v1/glossaries/name/{glossaryName}`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/glossary/v1/glossaries/name/{glossaryName}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `DATA_CATALOG_READ`

Use this API to retrieve the details for the specified business glossary. The response will include details such as the glossary ID, description, and created date.

## Path parameters

- `glossaryName` string, required

## Response `200`

OK 
Glossary Details retrieved successfully.

- DataUseGovernanceDataCatalogOneTrustResponseOfGlossaryResponse
  - `data` DataUseGovernanceDataCatalogGlossaryResponse
    - `id` string, uuid: Unique identifier
    - `name` string: Name of the entity
    - `nameKey` string: Key used for name localization
    - `numericId` integer: Numeric identifier for the glossary
    - `description` string: Description of the glossary
    - `descriptionKey` string: Key used for description localization
    - `businessOwner` string[]
    - `dataSteward` string[]
    - `subjectMatterExpert` string[]
    - `createdDate` string, date-time: Creation timestamp
    - `lastUpdatedDate` string, date-time: Last update timestamp
    - `createdBy` string, uuid: UUID of the user who created the glossary
    - `lastUpdatedBy` string, uuid: UUID of the user who last updated the glossary
    - `terms` DataUseGovernanceDataCatalogTermResponse[]
      - `id` string, uuid: Unique identifier
      - `name` string: Name of the entity
      - `nameKey` string: Key used for name localization
      - `type` string: Type of the term
      - `typeKey` string: Key used for type localization
      - `shortDescription` string: Brief description of the term
      - `glossary` DataUseGovernanceDataCatalogIdValueKeyDto
        - `id` string, uuid: Unique identifier
        - `value` string: Display value
        - `key` string: Key used for localization
      - `numericId` integer: Numeric identifier for the term
      - `example` string: Example usage of the term
      - `businessOwner` string[]
      - `technicalOwner` string[]
      - `dataSteward` string[]
      - `notes` string: Additional notes about the term
      - `source` string: Source of the term
      - `createdDate` string, date-time: Creation timestamp
      - `lastUpdatedDate` string, date-time: Last update timestamp
      - `createdBy` string, uuid: UUID of the user who created the term
      - `lastUpdatedBy` string, uuid: UUID of the user who last updated the term
      - `status` string: Current status of the term
      - `associatedTags` string[]
      - `tags` DataUseGovernanceDataCatalogTagResponse[]
        - `id` string, uuid: UUID of the tag
        - `tagId` integer: Numeric identifier for the tag
        - `name` string: Name of the tag
        - `description` string: Description of the tag
        - `type` string: Type of the tag
        - `createdBy` string, uuid: UUID of the user who created the tag
        - `createdDate` string, date-time: Tag creation timestamp
        - `updatedBy` string, uuid: UUID of the user who updated the tag
        - `updatedDate` string, date-time: Tag update timestamp
        - `athenaId` string, uuid: Athena Id for the tag
  - `meta` DataUseGovernanceDataCatalogOneTrustMetadata
    - `page` DataUseGovernanceDataCatalogOneTrustPage
      - `first` boolean: This parameter indicates whether the current page is the first page of the list.
      - `last` boolean: This parameter indicates whether the current page is the last page of the list.
      - `number` integer: The page number of the results.
      - `size` integer: The number of results per page.
      - `totalElements` integer: The total number of results in the list.
      - `totalPages` integer: The total number of pages in the list.
      - `sort` DataUseGovernanceDataCatalogOneTrustSort[]: The sort criteria that dictates the order of the results.
        - `direction` 'ASC' | 'DESC': The order (ASC|DESC) by which results are sorted.
        - `property` string: The criteria by which results are sorted.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/data-use-governance-data-catalog.md) - [All operations](https://skmtc.dev/onetrust/apis/data-use-governance-data-catalog/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/data-use-governance-data-catalog/revisions/df847e469733?raw)