Skip to main content

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​

OK

Schema

    id uuidrequired

    The unique id of the brand.

    state string

    The current state of the brand.

    Example: pending
    name string

    Brand/Marketing/DBA name of the business if applicable..

    Example: My Brand
    company_name string

    The legal name of the business.

    Example: BrandCo
    contact_email string

    A company contact email for this brand.

    Example: brand_info@example.com
    contact_phone string

    A contact phone number for this brand.

    Example: +18995551212
    ein_issuing_country string

    Country of registration.

    Example: United States
    legal_entity_type string

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

    Example: Private Company
    ein string

    Company EIN Number/Tax ID

    Example: 12-3456789
    company_address string

    Full company address.

    Example: 123 Brand St, Hill Valley CA, 91905
    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).

    Example: Healthcare
    company_website string

    Link to the company website.

    Example: www.example.com
    csp_brand_reference string

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

    Example: null
    csp_self_registered boolean

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

    Example: false
    status_callback_url string

    Optional: Specify a URL to receive webhook notifications when your brand’s state changes.

    Example: https//example.com/handle_callback
    created_at date-time
    updated_at date-time