List Categories

GET/v1/categories

Use it in a workflow

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

Fields

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.

Response

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

objectstring

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

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of category objects.

One ofdataDefault "data"

dataarray<object>

idstring

Unique category ID assigned by Voucherify.

namestring

Category name.

hierarchyinteger

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

objectstring

The type of the object represented by the JSON. This object stores information about the category.

One ofcategoryDefault "category"

created_atstring (date-time)

Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.

updated_atstring (date-time)

Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.

totalinteger

Total number of categories.

json

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "string",
      "name": "string",
      "hierarchy": 0,
      "object": "category",
      "created_at": "2022-07-14T10:45:13.156Z",
      "updated_at": "2022-08-16T10:52:08.094Z"
    }
  ],
  "total": 0
}

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

Was this page helpful?