Get List

vessel

The token for the customer's CRM account. This was generated when they connected their account.

Returns all fields including non-unifiable and custom fields under the "additional" property in the response

Provide the `nextPageCursor` value from the previous request to retrieve the next set of ids

VesselAPIToken

responseBody

accessToken

objectType

cursor

allFields

vessel-api-token

The token for the customer's account. This was generated when they connected their account.

The number of records to return per page.

limit

(Alias: company, organization) An organization involved with your business.

Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton

Blue Cross

Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM

Address

The timestamp that the account was created

A description of this Company/Account. Not supported by Pipedrive

The timestamp the account was last modified

The primary phone number. Not supported by Pipedrive

Account

Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details.

The Id of the User to assign this Account to

The primary phone | Not supported by Pipedrive

AccountCreate

The primary phone| Not supported by Pipedrive

AccountUpdate

The timestamp that the call object was created

Possibly an enum, See /details endpoint for values.

The phone number called from.
*CRM Caveats* Only supported for HubSpot.

The timestamp the call object was last modified

The URL of the recording of the call.
*CRM Caveats* Only supported for HubSpot.

The phone number that was called.
*CRM Caveats* Only supported for HubSpot.

Call

The participants involved in this call. If this is an inbound call, this is the contacts that called, if this is an outbound call, this is the contacts that were called.

ISO Formatted date for when the call occurred

See /details endpoint for possible values.

CallCreate

CallUpdate

Connection

Information about an individual affiliated with another CRM Object (e.g., a Lead, a Deal, etc)

Director of Operations

The timestamp that the contact was created

The primary mobile phone number for this contact. Possibly the same as the phone number.

The timestamp the contact was last modified

The primary phone number for this contact

Contact

Properties that a contact can be created with

The Id of the account to associate this contact with

The Id of the User to assign this Contact to

ContactCreate

ContactUpdate

Used for overriding the default key generated from the name of the field. Not supported for Close

(Alias: Opportunity) An object representing either the opportunity to sell a product to an Account, or in the case of an `isWon` deal, a product sold to an Account.
*CRM Caveats*:
- Pipedrive: Users must have "Deal probability" turned on for the given pipeline for probability to be configurable and returned.

Blue Cross Deal

probability * amount. This is a computed property

If this deal is closed (either closed-won or closed-lost). This is a computed property based on stage

If this deal has been won. This is a computed property based on stage

Decimal probability of closing this deal.

The stage of the pipeline the deal is in. See /deal/details for possible values

Deal

The Id of the account to associate this deal with

Only supported for Salesforce and HubSpot. The Id of the contact to associate this deal with

The stage the deal is in. See /deal/details for possible value

DealCreate

Update the account this deal is associated with.

The stage the deal is in. See /deal/details for possible values

DealUpdate

An email is a message sent from one person to another through an email service. Emails involve participants - the person who the email was sent to, or the person that sent it. Participants are usually a Contact, Lead, or User but in certain CRMs, can be a person not yet associated with a CRM object.

<p>Hi Greg, need any paper? - Michael</p>

BlueCross <> Dunder Mifflin

The email addresses that received a blind copy of the email

The email addresses that received a copy of the email

The timestamp that the email object was created

If this email was sent to the user or sent by the user

The date the email was created. This can be set when creating the email object and is not necessarily the same as the `createdTime` field.

The timestamp the email object was last modified

The status of the email (CRM specific, see /details).

The email addresses that received the email

Email

Associated Contacts must participate in the email (i.e., have a role).

Associated Leads must participate in the email (i.e., have a role).

EmailCreate

EmailUpdate

Events are a type of activity that has attendees and takes place at a certain point in time (i.e., has a start and end date).
For the currently supported CRMs, these are the objects Events most closely maps to:
- Salesforce = Events
- HubSpot = Meetings
- Pipedrive = Activities
- Zoho = Events

Going to get tea with Tom from Blue Cross to discuss his paper needs

Meeting with Blue Cross

Where this event takes place. Can be virtual

The timestamp the event was last modified

Event

Event Attendees hold information about someone who attendeed or was invited to an event. Attendees are always associated with some Event and another person object such as a Contact, Lead, or Other.

The object type of the associated object (e.g., Contact, Lead, etc) or Other if this Attendee is not associated with a CRM object

The timestamp that the event attendee was created

The timestamp the event attendee was last modified

EventAttendee

Required unless email is present and CRM supports "Other" for associatedObjectType

Required if associationId is not present and the CRM supports "Other" for attendee associatedObjectType 

EventAttendeeCreate

EventAttendeeUpdate

EventCreate

EventUpdate

(Alias: property) A field is a key-value pair on a CRM Object that provides information about that object.

number of employees

If this field can be used when creating the object

The key in the CRM object (ex: annualRevenue, numberOfEmployees, etc)

The display name of this field (ex: number of employees, annual revenue, etc)

If this field is required when creating the object

If this is a field we've unified across CRMs

Field

Hubspot

Integration

Ids that didn't return anything. Will be an empty array if all Ids are valid.

A Lead represents an individual, or sometimes an organization, that is interested in purchasing your product (i.e., is a potential Deal).
*CRM Caveats*:
- HubSpot: we consider contacts with the `leadStatus` set to be leads.

Name of the Account associated with this lead

The primary mobile phone number for this lead. Possibly the same as the phone number

Lead

Name of the Account associated with this lead. Not supported for Pipedrive. Defaults to `[TODO]: Fill in Company Name` in Salesforce

The primary mobile phone number for this lead. Possibly the same as the phone number.

LeadCreate

Name of the Account associated with this lead. Not supported for Pipedrive

The primary mobile phone number for this lead. Possibly the same as the phone number. Not supported for Pipedrive

The primary phone. Not supported for Pipedrive

LeadUpdate

string

List

This note has some interesting content in it!

The body of the note (populated if CRM notes support html)

The body of the note (populated if CRM notes only support plaintext)

Note

Create a new Note. You may only associate a note with at most one entity of each type upon creation.

Required unless leadId/dealId/contactId are specified.

Required unless leadId/accountId/dealId are specified.

Required unless leadId/accountId/contactId are specified.

Required unless dealId/accountId/contactId are specified.

The user to assign this note to. If there is no ownerUserId provided, the behavior is defined by the downstream system (either assigned to no user or to the user that installed the app).

NoteCreate

Update an existing Note. Please note that updating associations is not currently supported.

NoteUpdate

High Priority Task

Task

Can only set either leadId or dealId but not both.

ISO Formatted Date for the due date of the task

If both `isDone` and `status` are included, `isDone` will take precedence and automatically set `status` to either the default or a 'closed' status depending on the `isDone` value.

TaskCreate

TaskUpdate

Users of the connected CRM platform. These are *not* the contacts or leads, but rather the user accounts from the connected CRM.

User

WebhookMetadata

WebhookMetadataCreate

CRM API Reference

Integrations

[V1] CRM APIs

Engagement APIs

CRM APIs

Marketing Automation APIs

Dialer APIs

Chat APIs

x-vessel-api-token

Vessel

Home

Get API Keys

Powerful native go-to-market integrations in minutes

About

Step by Step guide for integrating Vessel into your product

Integrate Vessel

Integrate with one Vessel API to integrate with many integrations at once.

Unified APIs

A direct interface to the downstream provider for when you need more fine-grained control than the Unified API gives you.

Actions APIs

What is the Synced-Cache and why you might want to enable it.

Synced-Caches

Webhooks

Effortlessly push data directly into your database.

Managed ETL

List Integrations

Exchange the session token for an access token. The access token is the secret key used to refer to a specific connected integration.

Get Access Token

Call this endpoint to start a new Authentication Session before authenticating your User's integration.

Get Session Token

List all connections associated with this api token.

List Connections

Find Connection

Delete Connection

Send an authenticated passthrough request to the downstream system. This is useful for making requests to endpoints that are not yet supported by Vessel.

CRM APIs

How-To Guides

References

Tutorials

Unified API

Passthrough

Link

Connection

Get List

Authorizations

Query Parameters

Response