List Metadata Schemas

List Metadata Schema Definitions

GET/v1/metadata-schemas

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Metadata Schemas action (under Metadata Schemas).
Fill in the fields below, then reference the result from later steps as {{listMetadataSchemas.response.data}}.

baseUrlstring

The API host this action calls. Override to point at a different environment.

Default "https://{cluster}.voucherify.io"

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Returns 200 with an object. Read it in later steps with {{listMetadataSchemas.response.data.<field>}}.

objectstring

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

One oflistDefault "list"

data_refstring

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

One ofschemasDefault "data"

schemasarray<object>

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

totalinteger

The total number of metadata schema objects.

json

{
  "object": "list",
  "data_ref": "data",
  "schemas": [
    {}
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?