Request Access

vessel-api-token

Vessel

Contact us

Welcome

Getting Started

Accessing Native Data

Authentication and Security

Webhooks

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

accessToken

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

allFields

cursor

The number of records to return per page.

limit

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

Account

AccountCreate

AccountUpdate

An action represents some work that needs to be done in order to progress a sequence to the next step.

Action

Complete a call or other action to move a prospect in a sequence to the next step.

ActionComplete

Address

A phone call between a User and an external Contact

Call

Call Disposition

Connection

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

Contact

Properties that a contact can be created with

ContactCreate

ContactUpdate

(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.

Deal

DealCreate

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.

Email

EmailCreate

EmailAddress

EmailUpdate

Properties that an account can be created with

Properties that an account can be update with

An known individual affiliated with an Account, Deal, etc

Properties that a contact can be updated with

A email between a User and an external Contact

Integration

Mailboxes in the connected engagement platform. These are email accounts that outbound emails will be sent from.

Mailbox

Sequences in the connected engagement platform. These are often used to schedule outbound emails, or other tasks.

Sequence

SequenceStart

Task

TaskComplete

Properties that a task can be created with

TaskCreate

Properties that a task can be updated with

TaskUpdate

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

User

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

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.

EventAttendee

EventAttendeeCreate

EventAttendeeUpdate

EventCreate

EventUpdate

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

Field

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.

Lead

LeadCreate

LeadUpdate

Note

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

NoteCreate

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

NoteUpdate

Phone

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

WebhookMetadata

WebhookMetadataCreate

Vessel's APIs requires an access token to be used together with your Vessel API token. Ensure the following headers are provided when making API calls:

Key | Value | Description
---------|----------|----------
 vessel-api-token | `<VESSEL_API_TOKEN>` | The API token provided by us
 
Additionally, in the query or body parameters of each request depending on whether it is a GET or POST, make sure to include the `accessToken` for the connection you want to access.

API Reference

Remove a connection for a given `connectionId`. Removing a connection disconnects the user's CRM so they'll need to re-authenticate should they want to re-connect their CRM.

Get info about a connection for a given accessToken.

List all established connections for a workspace

Return all of the CRM integrations supported by Vessel.

Return all of the Engagement Platform integrations supported by Vessel.

Removes a webhook for a given connection and id

Retrieve information about a webhook for a given connection and id

Create a new webhook for a given connection

Get details about all accounts. 
Details include the type, possible values, and other meta data about the fields.

Retrieve all Accounts
*CRM Caveats*:
- Pipedrive: dealIds + contactIds not supported when querying for all accounts

Retrieve a Contact by either Id or email. When both email and Id are included, Id will take priority.

Get details about all contacts. 
Details include the type, possible values, and other meta data about the fields.

Get details about all deals or a particular deal. 
Details include the type, possible values, and other meta data about the fields.

Update an Email by Id.
*CRM Caveats*:
- Pipedrive: Not supported.

Create a new Email.
*CRM Caveats*:

- Pipedrive: Not supported.

Get details about all emails. 
Details include the type, possible values, and other meta data about the fields.

Retrieve Event Attendees by a set of Id's

Get details about all event attendees. 
Details include the type, possible values, and other meta data about the fields.

Get details about all events. 
Details include the type, possible values, and other meta data about the fields.

Get details about all leads. 
Details include the type, possible values, and other meta data about the fields.

Retrieve all leads.
*CRM Caveats*:
- Pipedrive: Only `jobTitle` is returned when querying for all leads

Create a new Note.
*CRM Caveats*:
- Salesforce: You may only associate a Note with one entity.

Get details about all notes. 
Details include the type, possible values, and other meta data about the fields.

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

Create a new Task.
*CRM Caveats*:
- Salesforce: You may only associate a Task with either a Lead or a Contact *and* either a Deal or an Account.

Get details about all tasks. 
Details include the type, possible values, and other meta data about the fields.

Get details about all users. 
Details include the type, possible values, and other meta data about the fields.

Complete an action to move a prospect to the next step of a sequence.

Exchanges the public token for an access token used to interact with the account. Store the access token in a secure location.

Generates a link token to be used during the authentication flow. This token is passed to either the Vessel Link Component or `useVesselLink` hook.

Get Webhook

Parameters

Response

​Parameters

​Response

Parameters

Response