1. API
  2. Get all Leads
GET
/crm/leads
vessel-api-token*

Parameters

accessTokenRequired
string
The token for the customer's CRM account. This was generated when they connected their account.
cursor
string
allFields
boolean
Returns all fields including non-unifiable and custom fields under the "additional" property in the response

Response

leads
array
modifiedTimeRequired
string
The date the lead was last modified
createdTimeRequired
string
The date that the lead was created
nativeIdRequired
string
Id in the downstream CRM
idRequired
string
firstName
string
lastName
string
jobTitle
string
email
string
account
string
Name of the Account associated with this lead
phone
string
The primary phone
mobilePhone
string
The primary mobile phone number for this lead. Possibly the same as the phone number.
additional
object
Returned when `allFields` is set in the query params. Includes all data, untransformed, we recieved from the downstream CRM
nextPageCursor
string