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

idintegerOptional

The unique identifier for the company

createdAtdatetimeOptional

The date and time when the company was created

namestringOptional

The name of the company

categoryenumOptional

The category of the company

addressstringOptional

The address of the company

einstringOptional

The Employer Identification Number (EIN) of the company

descriptionstringOptional

A description of the company

brandColorstringOptional

The brand color of the company

logoUrlstringOptional

The URL of the company’s logo

heroUrlstringOptional

The URL of the company’s hero image

primaryWebsiteUrlstringOptional

The primary website URL of the company

primaryWebsiteLabelstringOptional

The label for the primary website URL

primaryPhonestringOptional

The primary phone number of the company

primaryPhoneLabelstringOptional

The label for the primary phone number

primaryEmailstringOptional

The primary email address of the company

primaryEmailLabelstringOptional

The label for the primary email address

privacyPolicyUrlstringOptional

The URL of the company’s privacy policy

tosUrlstringOptional

The URL of the company’s terms of service

pocNamestringOptional

The name of the point of contact

pocTitlestringOptional

The title of the point of contact

pocEmailstringOptional

The email address of the point of contact

optInstringOptional

Explain how users will opt in to receive messages.

optOutstringOptional

Explain how users will opt out of receiving messages.

optOutKeywordslist of stringsOptional

Please provide the unique keywords to opt out. Each keyword should not contain spaces.

agentUseCasestringOptional

Please define what your agent will do.

expectedAgentResponsesstringOptional

Please provide some example messages that your agent will send.

testNumberslist of stringsOptional

A list of test phone numbers

statusstringOptional

The approval status of the company

additionalWebsiteslist of objectsOptional

A list of additional websites

additionalEmailslist of objectsOptional

A list of additional email addresses

additionalPhoneNumberslist of objectsOptional

A list of additional phone numbers

Errors