Unified Chat APIs

vessel

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.

Passthrough Request

List Webhooks

Find Webhook

Create Webhook

Delete Webhook

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

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

Integrate with Salesforce, Zoho, HubSpot, and more

Unified CRM APIs

Integrate with Ringcentral, Aircall, and more

Unified Dialer APIs

Integrate with Outreach, Salesloft, and more

Unified Sales Engagement APIs

Integrate with ActiveCampaign, Mailchimp, and more

Unified Marketing Automation APIs

Get Connection Info

List Users

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

Batch Read Users

Get User

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

Get User Details

List Contacts

Batch Read Contacts

Get Contact

Create Contact

Update Contact

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

Get Contact Details

List Deals

Batch Read Deals

Get Deal

Create Deal

Update Deal

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

Get Deal Details

List Accounts

Batch Read Accounts

Get Account

Create Account

Update Account

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

Get Account Details

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

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

Get Lead Details

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

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

Get Note Details

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

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

Get Task Details

List Calls

Batch Read Calls

Get Call

Create Call

Update Call

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

Get Call Details

List Events

Batch Read Events

Get Event

Create Event

Update Event

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

Get Event Details

List Event Attendees

Get Event Attendee

Create Event Attendee

Update Event Attendee

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

Get Attendee Details

List Lists

Get List

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

Get List Details

Create Custom Field

Get All Users

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 Batch Contacts

Search Contacts

Update Contact Custom Field

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 Batch Deals

Search Deals

Get All Accounts

Get Batch Accounts

Search Accounts

Update Account Custom Field

Get All Leads

Get Batch Leads

Search Leads

Create Lead Custom Field

Update Lead Custom Field

Get All Notes

Get Batch Notes

Search Notes

Get All Tasks

Get Batch Tasks

Search Tasks

Get All Emails

Get Email

Create Email

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

Update Email

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.

Batch Calls

Search Calls

Get All Events

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

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

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

Integration	Unified API	Synced-Cache	Webhooks
Slack	✅	-	-
Teams	Beta	-	-

About

Unified API

​Integration Feature Support

Integration Feature Support