company

Get company's information

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

get/company

Request

  • Base URL: https://www.trypinnacle.dev/api
  • URL: https://www.trypinnacle.dev/api/company
  • Auth: API key in header PINNACLE-API-Key

Query parameters

companyIdinteger

The unique identifier for the company

companyNamestring

The name of the company

Response

Successfully retrieved company information

idinteger

The unique identifier for the company

createdAtstring date-time

The date and time when the company was created

namestring

The name of the company

category'Entertainment' | 'Finance' | 'Food & Beverage' | 'Games' | 'Health' | 'Misc' | 'News' | 'Other' | 'Productivity' | 'Shopping & Retail' | 'Social' | 'Sports' | 'Travel' | 'Utilities'
addressstring

The address of the company

einstring

The Employer Identification Number (EIN) of the company

descriptionstring

A description of the company

brandColorstring

The brand color of the company

logoUrlstring

The URL of the company's logo

heroUrlstring

The URL of the company's hero image

primaryWebsiteUrlstring

The primary website URL of the company

primaryWebsiteLabelstring

The label for the primary website URL

primaryPhonestring

The primary phone number of the company

primaryPhoneLabelstring

The label for the primary phone number

primaryEmailstring

The primary email address of the company

primaryEmailLabelstring

The label for the primary email address

privacyPolicyUrlstring

The URL of the company's privacy policy

tosUrlstring

The URL of the company's terms of service

pocNamestring

The name of the point of contact

pocTitlestring

The title of the point of contact

pocEmailstring

The email address of the point of contact

optInstring

Explain how users will opt in to receive messages.

optOutstring

Explain how users will opt out of receiving messages.

optOutKeywordsstring[]

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

agentUseCasestring

Please define what your agent will do.

expectedAgentResponsesstring

Please provide some example messages that your agent will send.

testNumbersstring[]

A list of test phone numbers

statusstring

The approval status of the company

Changes

No recorded changes to this operation across all 1 revision of this API.