v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Management

Get Metadata Schema

Retrieves a metadata schema.

📘 Metadata Documentation

Read the Getting Started with Metadata and Metadata Mapping articles to learn how metadata work in Voucherify.

get/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}

Response

Returns the metadata schema.

idstring required

Unique identifier of the metadata schema.

related_objectstring 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".

propertiesobject required

Contains metadata definitions.

allow_defined_onlyboolean 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_atstring 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_atstring 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.

objectstring required

The type of the object represented by the JSON. This object stores information about the metadata schema.

Example response

{
  "created_at": "2021-12-03T13:33:44.556Z",
  "updated_at": "2022-08-11T08:05:30.695Z"
}