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.

Permissions

The API token must include the following scopes: Messaging.

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 — OPTIONAL links object — OPTIONAL self string — OPTIONAL first string — OPTIONAL next string — OPTIONAL prev string — OPTIONAL data object[] — OPTIONAL id uuid The unique id of the brand. state string — OPTIONAL The current state of the brand. name string — OPTIONAL A name for the brand. company_name string — OPTIONAL Full company name and DBA if applicable. contact_email string — OPTIONAL A company contact email for this brand. contact_phone string — OPTIONAL A contact phone number for this brand. ein_issuing_country string — OPTIONAL Country of registration. legal_entity_type string — OPTIONAL What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT) ein string — OPTIONAL Company EIN Number/Tax ID company_address string — OPTIONAL Full company address. company_vertical string — OPTIONAL 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 — OPTIONAL Link to the company website. csp_brand_reference string — OPTIONAL If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit) csp_self_registered boolean — OPTIONAL This value must be true for all self-registered brands. created_at date-time — OPTIONAL updated_at date-time — OPTIONAL