List all Brands.

GET 
/registry/beta/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.

Request

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

application/json

Schema

Schema

links

object

self string

first string

next string

prev string
data object[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "state": "pending",
      "name": "My Brand",
      "company_name": "BrandCo",
      "contact_email": "brand_info@example.com",
      "contact_phone": "+18995551212",
      "ein_issuing_country": "United States",
      "legal_entity_type": "Private Company",
      "ein": "12-3456789",
      "company_address": "123 Brand St, Hill Valley CA, 91905",
      "company_vertical": "Healthcare",
      "company_website": "www.example.com",
      "csp_brand_reference": null,
      "csp_self_registered": false,
      "status_callback_url": "https//example.com/handle_callback",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}

Loading...