---
title: "List Metadata Schema Definitions"
method: GET
path: "/v1/metadata-schemas"
tags: ["Metadata Schemas"]
---

# List Metadata Schema Definitions

`GET /v1/metadata-schemas`

Retrieve metadata schema definitions.

>📘 Management API
>
>If you have Management API enabled, you can also use the [List Metadata Schemas](/api-reference/management/list-metadata-schemas) endpoint to list all metadata schemas.

## Response `200`

Returns an array of metadata schema definitions. The response does not include unknown metadata properties in the response, i.e. those that have been defined outside of the **Project Settings** > **Metadata Schema** definitions. For example, an unknown metadata property can be defined in the campaign manager while creating a campaign.

- MetadataSchemasListResponseBody — Object containing a list of metadata schemas.
  - `object` 'list', required — The type of the object represented by JSON. This object stores information about the metadata schemas in a dictionary.
  - `data_ref` 'schemas', required — Identifies the name of the attribute that contains the array of metadata schema objects.
  - `schemas` MetadataSchemaDeprecated[] — Array of metadata schema objects. The metadata schemas are listed by related object properties.
    - `id` string, required — Unique identifier of the metadata schema.
    - `related_object` string, required — The resource type. You can define custom metadata schemas, which have a custom `"related_object"` resource type. The standard metadata schemas are: `"campaign"`, `"customer"`, `"earning_rule"`, `"loyalty_tier"`, `"order"`, `"order_item"`, `"product"`, `"promotion_tier"`, `"publication"`, `"redemption"`, `"reward"`, `"voucher"`.
    - `properties` object, required — Contains metadata definitions.
    - `allow_defined_only` boolean, nullable, required — Restricts the creation of metadata fields when set to `true`. It indicates whether or not you can create new metadata definitions, e.g. in the campaign or publication manager. If set to `true`, then only the defined fields are available for assigning values.
    - `created_at` string, date-time, required — Timestamp representing the date and time when the metadata schema was created. The value for this parameter is shown in the ISO 8601 format.
    - `updated_at` string, date-time, nullable, required — Timestamp representing the date and time when the metadata schema was updated. The value for this parameter is shown in the ISO 8601 format.
    - `object` string, required — The type of the object represented by the JSON. This object stores information about the metadata schema.
  - `total` integer, required — The total number of metadata schema objects.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/revisions/4982266e0494/schema)