Companies
Those endpoints allow you to interact with companies (also called accounts) within CRMs.
GET - /crm/companies
Fetch a page of companies from the CRM Vendor, and give you a pageToken for the next page if there is one
Headers
user-id-from-vendor
required
string
Your user's ID from the vendor
URL Parameters
pageID
optional
string
The pagination ID from the previous request
sortBy
optional
created
updated
Sort the results. Note: some vendors have a stricter rate limitation when sorting the records (Hubspot for example). If you do not care about sorting, it is preferable to leave the field undefined.
Responses
200
vendor
required
Atlassian
Clickup
Dropbox
Google
Hubspot
Microsoft
Notion
Salesforce
Slack
data
required
array of object
id
required
string
createdAt
optional
string
The creation date as an ISO string
updatedAt
optional
string
The last update date as an ISO string
name
optional
string
The company name
industry
optional
string
The industry of the company
websites
required
array of string
The websites of the company
emails
required
array of object
email
required
string
The emails associated with the company
telephones
required
array of object
number
required
string
type
optional
string
addresses
required
array of object
street
optional
string
city
optional
string
state
optional
string
addressType
optional
string
postalCode
optional
string
country
optional
string
ISO letters for country
numberOfEmployees
optional
number
archived
optional
boolean
nextPage
required
object
pageID
optional
string
The next page ID, is undefined when there is no more pages
GET - /crm/company
Fetch a single company from the vendor using the ID
Headers
user-id-from-vendor
required
string
Your user's ID from the vendor
URL Parameters
companyID
required
string
The ID from the vendor of the company you want to retrieve
Responses
200
id
required
string
createdAt
optional
string
The creation date as an ISO string
updatedAt
optional
string
The last update date as an ISO string
name
optional
string
The company name
industry
optional
string
The industry of the company
websites
required
array of string
The websites of the company
emails
required
array of object
email
required
string
The emails associated with the company
telephones
required
array of object
number
required
string
type
optional
string
addresses
required
array of object
street
optional
string
city
optional
string
state
optional
string
addressType
optional
string
postalCode
optional
string
country
optional
string
ISO letters for country
numberOfEmployees
optional
number
archived
optional
boolean