Interface with your users' platform through one unified schema and data model. Vessel makes it easy to build support for many integrations at once through one API.

About

CRM APIs

Engagement APIs

[BETA] CRM APIs

Unified APIs

Actions APIs

Managed ETL

x-vessel-api-token

Vessel

Home

Get API Keys

Powerful native go-to-market integrations in minutes

Step by Step guide for integrating Vessel into your product

Integrate Vessel

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

List Connections

Find Connection

Delete Connection

How to create, delete, and list your available OAuth apps

Managing OAuth Apps

List OAuth Apps

Find OAuth App

Create OAuth App

Delete OAuth App

Effortlessly push data directly into your database.

Universal CRM API. Our most powerful and feature rich Universal API.

Setting up the CRM API

How to handle errors from the Vessel CRM API

Error Handling

Accessing Native Data

Authentication and Security

Webhooks

List Users

Batch Read Users
*CRM Caveats*:
  Not supported for HubSpot.

Batch Read Users

Get User

List Contacts

Batch Read Contacts

Get Contact

Create Contact

Update Contact

List Deals

Batch Read Deals

Get Deal

Create Deal

Update Deal

List Accounts

Batch Read Accounts

Get Account

Create Account

Update Account

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

List Leads

Fetch Leads by Ids
*CRM Caveats*:
- Pipedrive: Only `jobTitle` is returned when querying for all leads

Batch Read Leads

Get Lead

Create Lead

Update Lead

Create Lead Custom Field

List Notes

Batch Read Notes

Get Note

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

Create Note

Update Note

List Tasks

Batch Read Tasks

Get Task

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.

Create Task

Update Task

List Emails

Batch Read Emails

Get Email

Create Email

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

Update Email

List Calls

Batch Read Calls

Get Call

Create Call

Update Call

List Events

Batch Read Events

Get Event

Create Event

Update Event

List Event Attendees

Get Event Attendee

Create Event Attendee

Update Event Attendee

List Lists

Get List

Get All Users

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

Get User Details

Get Batch Users

Search Users

Associations for Users

Get All Contacts

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 Contact Details

Get Batch Contacts

Search Contacts

Get All Deals

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

Get Deal Details

Get Batch Deals

Search Deals

Get All Accounts

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

Get Account Details

Get Batch Accounts

Search Accounts

Get All Leads

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

Get Lead Details

Get Batch Leads

Search Leads

Get All Notes

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

Get Note Details

Get Batch Notes

Search Notes

Get All Tasks

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

Get Task Details

Get Batch Tasks

Search Tasks

Get All Emails

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

Get Email Details

Get Batch Emails

Search Emails

Get All Calls

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

Get Call Details

Batch Calls

Search Calls

Get All Events

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

Get Event Details

Get Batch Events

Search Events

Get All Event Attendees

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

Get Event Attendee Details

Search Event Attendees

Get All Lists

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

Create Link Token

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

Exchange Public Token for Access Token

Return all of the CRM integrations supported by Vessel.

Get CRM Integrations

Get info about a connection for a given accessToken.

Get Connection

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.

List all established connections for a workspace

Get All Connections

Create a new webhook for a given connection

Create Webhook

Retrieve information about a webhook for a given connection and id

Get Webhook

Removes a webhook for a given connection and id

Remove Webhook

Start a Call

Find Contact

Find List

List Sequences

Create an empty Sequence. To add steps to the sequence, use the /engagement/sequence-steps/batch-create endpoint.

Create Sequence

Start Sequence

List Custom Fields

Create Custom Field

List Mailboxes

Create one or more steps in a sequence. Some providers, such as Salesloft, only allow you to call this endpoint once.

Batch Create Sequence Steps

Update Message

Create Message

List Channels

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

Get All Custom Fields

Get All Actions

Get Action

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

Complete Action

Complete Task

Get All Call Dispositions

Get All Sequences

Create an empty Sequence. To add steps to the sequence, use the /engagement/sequence/step endpoint.

Create Sequence Step

Get All Mailboxes

Return all of the Engagement Platform integrations supported by Vessel.

Unified APIs

Dialer API

Marketing Automation API

Engagement API

Chat API

About

Integrations

Support

Unified APIs

Dialer API

Marketing Automation API

Engagement API

Chat API

​Integrations

​Support

Integrations

Support