Skip to main content

List all Brands.

Returns a list of your Brands. The brands are returned sorted by creation date, with the most recent appearing first. The list is filterable by sending in any of the following parameters.

Query Parameters
filter_name string

The name given to the brand. Will return all Brands containing this value as a substring.

filter_state string

The state of the brand in the registration process, such as pending or complete. Will return all Brands with this value.

Responses
200

OK

Schema
links object
self string
first string
next string
prev string
data object[]
id uuid

The unique id of the brand.

state string

The current state of the brand.

name string

A name for the brand.

company_name string

Full company name and DBA if applicable.

contact_email string

A company contact email for this brand.

contact_phone string

A contact phone number for this brand.

ein_issuing_country string

Country of registration.

legal_entity_type string

What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT)

ein string

Company EIN Number/Tax ID

company_address string

Full company address.

company_vertical string

An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION).

company_website string

Link to the company website.

csp_brand_reference string

If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit)

csp_self_registered boolean

This value must be true for all self-registered brands.

created_at date-time
updated_at date-time