Retrieve a Brand

GET 
/registry/beta/brands/:id

Retrieves the details of a Brand that has been previously created. Use the unique ID that was returned from your previous request to identify the specific Brand.

Permissions

The API token must include the following scopes: Messaging.

Request

Path Parameters

id uuidrequired

Unique ID of the brand

Responses

200

OK

application/json

Schema

Schema

iduuidrequired

The unique id of the brand.

statestring
The current state of the brand.
Example: pending
namestring
Brand/Marketing/DBA name of the business if applicable..
Example: My Brand
company_namestring
The legal name of the business.
Example: BrandCo
contact_emailstring
A company contact email for this brand.
Example: brand_info@example.com
contact_phonestring
A contact phone number for this brand.
Example: +18995551212
ein_issuing_countrystring
Country of registration.
Example: United States
legal_entity_typestring
What type of legal entity is the organization? (PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT)
Example: Private Company
einstring
Company EIN Number/Tax ID
Example: 12-3456789
company_addressstring
Full company address.
Example: 123 Brand St, Hill Valley CA, 91905
company_verticalstring
An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION).
Example: Healthcare
company_websitestring
Link to the company website.
Example: www.example.com
csp_brand_referencestring
If you are your own Campaign Service Provider, this is the approved Brand ID (Mandatory for CSPs, otherwise please omit)
Example: null
csp_self_registeredboolean
This value must be true for all self-registered brands.
Example: false
status_callback_urlstring
Optional: Specify a URL to receive webhook notifications when your brand’s state changes.
Example: https//example.com/handle_callback
created_atdate-time
updated_atdate-time

Example (from schema)

{
  "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"
}