Skip to main content
GET
/
v1
/
metadata-schemas
/
{resource}
Get Metadata Schema
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/metadata-schemas/{resource} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "ms_27vMXZqBAkkqBoOuw8EYTRLn",
  "related_object": "earning_rule",
  "properties": {
    "channel_id": {
      "type": "string",
      "array": true,
      "optional": true,
      "objectType": null,
      "exactLength": 5
    },
    "channel_name": {
      "eq": [
        "instagram",
        "facebook",
        "google",
        "twitter",
        "linkedin",
        "website"
      ],
      "type": "string",
      "array": false,
      "optional": true,
      "objectType": null
    }
  },
  "allow_defined_only": false,
  "created_at": "2022-08-25T13:09:59.970Z",
  "updated_at": "2022-08-25T13:11:15.704Z",
  "object": "metadata_schema"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

Path Parameters

​
resource
string
required

Response

​
id
string
required
​
related_object
string
required
​
properties
object
required
​
allow_defined_only
boolean | null
required
​
created_at
string<date-time>
required
Example:
​
updated_at
string<date-time> | null
required
Example:
​
object
string
default:metadata_schema
required