List Metadata Schemas

Lists all metadata schemas available in the project.

📘 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

List Metadata Schemas

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/metadata-schemas

200

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "ms_bwBVnq2YHcbsfCMfdqfCi4zl",
      "related_object": "Test-MANAPI-custom-schema-01",
      "properties": {
        "Test-manAPI-01": {
          "type": "string",
          "array": false,
          "optional": true,
          "object_type": null,
          "eq": [
            "Test-01",
            "Test-02",
            "Test-03",
            "Test-04"
          ]
        },
        "Test-manAPI-02": {
          "type": "number",
          "array": false,
          "optional": true,
          "object_type": null,
          "eq": [
            1,
            2,
            3,
            4
          ]
        },
        "Test-manAPI-03": {
          "type": "object",
          "array": false,
          "optional": true,
          "object_type": "unknown"
        },
        "Test-manAPI-04": {
          "type": "string",
          "array": true,
          "optional": true,
          "object_type": null,
          "eq": [
            "Value-01",
            "Value-02",
            "Value-03"
          ]
        }
      },
      "allow_defined_only": true,
      "created_at": "2024-04-18T17:24:46.980Z",
      "updated_at": "2024-04-18T18:17:20.108Z",
      "object": "metadata_schema"
    },
    {
      "id": "ms_ctw7O05ZLsMb1zFCGMRQ8qnP",
      "related_object": "campaign",
      "properties": {
        "Test-manAPI": {
          "type": "string",
          "array": true,
          "optional": true,
          "object_type": null,
          "eq": [
            "Test1",
            "Test2",
            "Test3"
          ],
          "max_length": 5,
          "min_length": 2
        },
        "Test-manAPI-08": {
          "type": "number",
          "array": false,
          "optional": true,
          "object_type": null,
          "eq": [
            105.5
          ],
          "lt": 9.5,
          "lte": 10.5
        },
        "Test-manAPI-09": {
          "type": "object",
          "array": true,
          "optional": false,
          "object_type": "Test-MANAPI-custom-schema-01",
          "deleted": true
        }
      },
      "allow_defined_only": false,
      "created_at": "2024-04-18T17:21:13.555Z",
      "updated_at": "2024-04-19T06:43:09.218Z",
      "object": "metadata_schema"
    },
    {
      "id": "ms_f0r4hm3ta6a4a5ch3ma",
      "related_object": "customer",
      "properties": {
        "age": {
          "type": "number",
          "array": false,
          "optional": true,
          "object_type": null
        },
        "Test-MANAPI-06": {
          "type": "string",
          "array": true,
          "optional": true,
          "object_type": null,
          "eq": [
            "Class-01,",
            "Class-02",
            "Class-03"
          ]
        },
        "Test-manAPI-07": {
          "type": "string",
          "array": false,
          "optional": true,
          "object_type": null,
          "eq": [
            "Tick",
            "Tack",
            "Toe"
          ]
        },
        "acquisition_channel": {
          "type": "string",
          "array": false,
          "optional": true,
          "object_type": null,
          "eq": [
            "Portal-01",
            "Portal-02",
            "Portal-03"
          ]
        },
        "customer_life_time_value": {
          "type": "number",
          "array": false,
          "optional": true,
          "object_type": null
        }
      },
      "allow_defined_only": false,
      "created_at": "2023-08-03T10:37:48.696Z",
      "updated_at": "2024-04-18T18:23:58.380Z",
      "object": "metadata_schema"
    },
    {
      "id": "ms_f1r5Tm3ta6a4a5ch3ma",
      "related_object": "order",
      "properties": {
        "region": {
          "type": "string",
          "array": false,
          "optional": true,
          "object_type": null,
          "eq": [
            "EU",
            "US",
            "EMEA",
            "APAC"
          ]
        },
        "location_id": {
          "type": "string",
          "array": true,
          "optional": true,
          "object_type": null,
          "eq": [
            "L1",
            "L2",
            "L3"
          ]
        },
        "payment_mean": {
          "type": "string",
          "array": true,
          "optional": true,
          "object_type": null,
          "eq": [
            "credit-card",
            "wire-transfer",
            "paypal"
          ]
        },
        "booking_end_date": {
          "type": "datetime",
          "array": false,
          "optional": true,
          "object_type": null
        },
        "booking_start_date": {
          "type": "datetime",
          "array": false,
          "optional": true,
          "object_type": null
        }
      },
      "allow_defined_only": false,
      "created_at": "2023-08-03T10:37:48.662Z",
      "updated_at": "2023-08-28T11:24:43.518Z",
      "object": "metadata_schema"
    },
    {
      "id": "ms_s3c0N6m3ta6a4a5ch3ma",
      "related_object": "product",
      "properties": {
        "brand": {
          "type": "string",
          "array": false,
          "optional": true,
          "object_type": null
        },
        "vendor": {
          "type": "string",
          "array": false,
          "optional": true,
          "object_type": null
        },
        "category": {
          "type": "string",
          "array": false,
          "optional": true,
          "object_type": null
        }
      },
      "allow_defined_only": false,
      "created_at": "2023-08-03T10:37:48.670Z",
      "updated_at": "2023-09-14T09:30:26.314Z",
      "object": "metadata_schema"
    },
    {
      "id": "ms_t4ir0Dm3ta6a4a5ch3ma",
      "related_object": "redemption",
      "properties": {
        "location_id": {
          "type": "string",
          "array": true,
          "optional": true,
          "object_type": null,
          "eq": [
            "L1",
            "L2",
            "L3"
          ]
        }
      },
      "allow_defined_only": null,
      "created_at": "2023-08-03T10:37:48.692Z",
      "updated_at": null,
      "object": "metadata_schema"
    }
  ],
  "total": 6
}

Path Parameters

projectId · string · required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

Response

200

application/json

Returns the details about the metadata schemas created in the project.

Object containing a list of metadata schemas.

object · enum<string> · default: list · required

The type of the object represented by JSON. This object stores information about the metadata schemas in a dictionary.

Available options: list

data_ref · enum<string> · default: data · required

Identifies the name of the attribute that contains the array of metadata schema objects.

Available options: data

data · object[] · required

Array of metadata schema objects. The metadata schemas are listed by related object properties.

Show child attributes

total · integer · required

The total number of metadata schema objects.