younifyd
Menu

List Brands

List Brands

GET/management/v1/projects/{projectId}/branding

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the List Brands action (under Management).
  3. Fill in the fields below, then reference the result from later steps as {{listBrands.response.data}}.

Request

Path parameters

projectIdstringrequired

Provide the unique identifier of the project.

Response

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

objectstring

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

One oflistDefault "list"

data_refstring

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

One ofdataDefault "data"

dataarray<object>

Array of brand objects. It contains only one object.

idstring

Unique identifier of the brand configuration.

brandobject5 fields

Defines basic brand details.

addressobject5 fields

Defines the address details.

contactobject2 fields

Defines contact details.

totalinteger

The total number of brand objects. It is always `1`.

json
{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "string",
      "brand": {
        "name": "string",
        "privacy_policy_url": "string",
        "terms_of_use_url": "string",
        "permission_reminder": "string",
        "website_url": "string"
      },
      "address": {
        "street": "string",
        "city": "string",
        "postal": "string",
        "state": "string",
        "country": "string"
      },
      "contact": {
        "email": "string",
        "phone": "string"
      }
    }
  ],
  "total": 0
}

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