---
title: "Retrieve metadata schema"
method: GET
path: "/rest/api/index/custom-metadata/schema/{groupName}"
tags: ["Custom Metadata"]
---

# Retrieve metadata schema

`GET /rest/api/index/custom-metadata/schema/{groupName}`

Retrieves the current schema definition for a metadata group.

## Response `200`

OK

- CustomMetadataSchema — Schema for custom metadata containing metadata key definitions
  - `metadataKeys` CustomMetadataPropertyDefinition[], required — Array of metadata key definitions
    - `name` string, required — The name of the metadata key.
    - `propertyType` 'TEXT' | 'PICKLIST' | 'TEXTLIST' | 'MULTIPICKLIST', required — The type of metadata key. This governs the search and faceting behavior.
    - `skipIndexing` boolean — If true then the property will not be indexed for retrieval and ranking.

## Other responses

- `401` — Not Authorized
- `404` — Not Found
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/gleanwork/apis/glean-api-2.md) · [All operations](https://skmtc.net/gleanwork/apis/glean-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gleanwork/glean-api-2/versions/c4ae998a3802/schema)