VOvoucherifyio
Metadata Schemas

List Metadata Schema Definitions

Retrieve metadata schema definitions.

📘 Management API

If you have Management API enabled, you can also use the List Metadata Schemas endpoint to list all metadata schemas.

get/v1/metadata-schemas

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/metadata-schemas
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, metadata-schemas

Response

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.

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.

totalinteger required

The total number of metadata schema objects.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.