API ReferenceBrand Registration

Get company's information

Retrieve the company’s information (i.e. approval status, company name, etc.). Search by company ID or company name.

Headers

PINNACLE-API-KeystringRequired

Query parameters

companyIdintegerOptional
The unique identifier for the company
companyNamestringOptional
The name of the company

Response

Successfully retrieved company information
idinteger or null
The unique identifier for the company
createdAtdatetime or null
The date and time when the company was created
namestring or null
The name of the company
categoryenum or null
The category of the company
addressstring or null
The address of the company
einstring or null

The Employer Identification Number (EIN) of the company

descriptionstring or null
A description of the company
brandColorstring or null
The brand color of the company
logoUrlstring or null
The URL of the company's logo
heroUrlstring or null
The URL of the company's hero image
primaryWebsiteUrlstring or null
The primary website URL of the company
primaryWebsiteLabelstring or null
The label for the primary website URL
primaryPhonestring or null
The primary phone number of the company
primaryPhoneLabelstring or null
The label for the primary phone number
primaryEmailstring or null
The primary email address of the company
primaryEmailLabelstring or null
The label for the primary email address
privacyPolicyUrlstring or null
The URL of the company's privacy policy
tosUrlstring or null
The URL of the company's terms of service
pocNamestring or null
The name of the point of contact
pocTitlestring or null
The title of the point of contact
pocEmailstring or null
The email address of the point of contact
optInstring or null
Explain how users will opt in to receive messages.
optOutstring or null
Explain how users will opt out of receiving messages.
optOutKeywordslist of strings or null
Please provide the unique keywords to opt out. Each keyword should not contain spaces.
agentUseCasestring or null
Please define what your agent will do.
expectedAgentResponsesstring or null
Please provide some example messages that your agent will send.
testNumberslist of strings or null
A list of test phone numbers
statusstring or null
The approval status of the company
additionalWebsiteslist of objects or null
A list of additional websites
additionalEmailslist of objects or null
A list of additional email addresses
additionalPhoneNumberslist of objects or null
A list of additional phone numbers

Errors