Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Metadata Schemas

Get Metadata Schema

Retrieves a metadata schema per resource type.

Resource types

Standard

You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter.

  • campaign
  • customer
  • earning_rule
  • loyalty_tier
  • order
  • order_item
  • product
  • promotion_tier
  • publication
  • redemption
  • reward
  • voucher

Custom

If you have defined a custom metadata schema, provide its name in the "resource" field to retrieve its details.

📘 Management API

If you have Management API enabled, you can also use the Get Metadata Schemas endpoint to retrieve a metadata schema using its ID.

get/v1/metadata-schemas/{resource}

Response

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.

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"
}