How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vessel CRM Unified API

The Vessel CRM Unified API (v2) normalizes CRM objects across Salesforce, HubSpot, Zoho, Pipedrive, Close, Freshsales, Microsoft Dynamics, Affinity and monday.com behind a single schema under /api/unifications/crm. It exposes list, find, batch-read, create, update and details operations for users, contacts, deals, accounts, leads, notes, tasks, events, emails, calls and lists. Published by Vessel as OpenAPI 3.1.0 with 69 operations.

Vessel CRM Unified API is one of 20 APIs that Vessel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRM, Contacts, Deals, Leads, and Normalized. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a GitHub repository.

This API exposes 69 operations across 69 paths, organized into 2 resource areas, and defines 44 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://api.vessel.dev.

69 operations 69 paths 44 schemas 69 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://api.vessel.dev
Authentication
API Key
Resource Areas
2

Authentication & Security 1

Vessel CRM Unified API declares 1 security scheme for authenticating requests. An API key is passed in the header as vessel-api-token (VesselAPIToken). By default, every request must be authenticated.

Paths & Operations 69

Across 69 paths, the API surfaces 69 operations — 69 POST. They span 2 resource areas: Operations, accounts. Each is listed below with its method, path, parameters, and response codes.

Operations 68
POST
/api/unifications/crm/info/find
Get Connection Info
get-info 1 param → 200
POST
/api/unifications/crm/users/list
List Users
list-users 1 param body → 200
POST
/api/unifications/crm/users/batch-read
Batch Read Users
batch-read-users 1 param body → 200
POST
/api/unifications/crm/users/find
Get User
get-user 1 param body → 200
POST
/api/unifications/crm/users/details
Get User Details
get-details-crm-user 1 param body → 200
POST
/api/unifications/crm/contacts/list
List Contacts
list-contacts 1 param body → 200
POST
/api/unifications/crm/contacts/batch-read
Batch Read Contacts
batch-read-contacts 1 param body → 200
POST
/api/unifications/crm/contacts/find
Get Contact
get-contact 1 param body → 200
POST
/api/unifications/crm/contacts/create
Create Contact
create-contact 1 param body → 200
POST
/api/unifications/crm/contacts/update
Update Contact
update-contact 1 param body → 200
POST
/api/unifications/crm/contacts/details
Get Contact Details
get-details-crm-contact 1 param body → 200
POST
/api/unifications/crm/deals/list
List Deals
list-deals 1 param body → 200
POST
/api/unifications/crm/deals/batch-read
Batch Read Deals
batch-read-deals 1 param body → 200
POST
/api/unifications/crm/deals/find
Get Deal
get-deal 1 param body → 200
POST
/api/unifications/crm/deals/create
Create Deal
create-deal 1 param body → 200
POST
/api/unifications/crm/deals/update
Update Deal
update-deal 1 param body → 200
POST
/api/unifications/crm/deals/details
Get Deal Details
get-details-crm-deal 1 param body → 200
POST
/api/unifications/crm/accounts/list
List Accounts
list-accounts 1 param body → 200
POST
/api/unifications/crm/accounts/batch-read
Batch Read Accounts
batch-read-accounts 1 param body → 200
POST
/api/unifications/crm/accounts/find
Get Account
get-account 1 param body → 200
POST
/api/unifications/crm/accounts/create
Create Account
create-account 1 param body → 200
POST
/api/unifications/crm/accounts/details
Get Account Details
get-details-crm-account 1 param body → 200
POST
/api/unifications/crm/leads/list
List Leads
list-leads 1 param body → 200
POST
/api/unifications/crm/leads/batch-read
Batch Read Leads
batch-read-leads 1 param body → 200
POST
/api/unifications/crm/leads/find
Get Lead
get-lead 1 param body → 200
POST
/api/unifications/crm/leads/create
Create Lead
create-lead 1 param body → 200
POST
/api/unifications/crm/leads/update
Update Lead
update-lead 1 param body → 200
POST
/api/unifications/crm/custom-fields/create
Create Custom Field
create-lead-custom-field 1 param body → 200
POST
/api/unifications/crm/leads/details
Get Lead Details
get-details-crm-lead 1 param body → 200
POST
/api/unifications/crm/notes/list
List Notes
list-notes 1 param body → 200
POST
/api/unifications/crm/notes/batch-read
Batch Read Notes
batch-read-notes 1 param body → 200
POST
/api/unifications/crm/notes/find
Get Note
get-note 1 param body → 200
POST
/api/unifications/crm/notes/create
Create Note
create-note 1 param body → 200
POST
/api/unifications/crm/notes/update
Update Note
update-note 1 param body → 200
POST
/api/unifications/crm/notes/details
Get Note Details
get-details-crm-note 1 param body → 200
POST
/api/unifications/crm/tasks/list
List Tasks
list-tasks 1 param body → 200
POST
/api/unifications/crm/tasks/batch-read
Batch Read Tasks
batch-read-tasks 1 param body → 200
POST
/api/unifications/crm/tasks/find
Get Task
get-task 1 param body → 200
POST
/api/unifications/crm/tasks/create
Create Task
create-task 1 param body → 200
POST
/api/unifications/crm/tasks/update
Update Task
update-task 1 param body → 200
POST
/api/unifications/crm/tasks/details
Get Task Details
get-details-crm-task 1 param body → 200
POST
/api/unifications/crm/events/list
List Events
list-events 1 param body → 200
POST
/api/unifications/crm/events/batch-read
Batch Read Events
batch-read-events 1 param body → 200
POST
/api/unifications/crm/events/find
Get Event
get-event 1 param body → 200
POST
/api/unifications/crm/events/create
Create Event
create-event 1 param body → 200
POST
/api/unifications/crm/events/update
Update Event
update-event 1 param body → 200
POST
/api/unifications/crm/events/details
Get Event Details
get-details-crm-event 1 param body → 200
POST
/api/unifications/crm/attendees/list
List Event Attendees
list-event-attendees 1 param body → 200
POST
/api/unifications/crm/attendees/batch-read
Batch Read Event Attendees
batch-read-event-attendees 1 param body → 200
POST
/api/unifications/crm/attendees/find
Get Event Attendee
get-event-attendee 1 param body → 200
POST
/api/unifications/crm/attendees/create
Create Event Attendee
create-event-attendee 1 param body → 200
POST
/api/unifications/crm/attendees/update
Update Event Attendee
update-event-attendee 1 param body → 200
POST
/api/unifications/crm/attendees/details
Get Attendee Details
get-details-crm-attendee 1 param body → 200
POST
/api/unifications/crm/emails/list
List Emails
list-emails 1 param body → 200
POST
/api/unifications/crm/emails/batch-read
Batch Read Emails
batch-read-emails 1 param body → 200
POST
/api/unifications/crm/emails/find
Get Email
get-email 1 param body → 200
POST
/api/unifications/crm/emails/create
Create Email
create-email 1 param body → 200
POST
/api/unifications/crm/emails/update
Update Email
update-email 1 param body → 200
POST
/api/unifications/crm/emails/details
Get Email Details
get-details-crm-email 1 param body → 200
POST
/api/unifications/crm/calls/list
List Calls
list-calls 1 param body → 200
POST
/api/unifications/crm/calls/batch-read
Batch Read Calls
batch-read-calls 1 param body → 200
POST
/api/unifications/crm/calls/find
Get Call
get-call 1 param body → 200
POST
/api/unifications/crm/calls/create
Create Call
create-call 1 param body → 200
POST
/api/unifications/crm/calls/update
Update Call
update-call 1 param body → 200
POST
/api/unifications/crm/calls/details
Get Call Details
get-details-crm-call 1 param body → 200
POST
/api/unifications/crm/lists/list
List Lists
list-lists 1 param body → 200
POST
/api/unifications/crm/lists/find
Get List
get-list 1 param body → 200
POST
/api/unifications/crm/lists/details
Get List Details
get-details-crm-list 1 param body → 200
accounts 1
POST
/api/unifications/crm/accounts/update
Update Account
update-account 1 param body → 200

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Email (17 properties), Deal (14 properties), Account (13 properties), EmailCreate (12 properties). Each schema is shown below with its type and property counts.

SyncedCache
boolean
If true, will hit the [synced-cache](/pages/home/synced-cache)
IncludeFields
object
1 property
NativeData
object
Native fields for the connected platform. For reads, this object is only returned if the include.$native field is set to true in the request body.
User
object
Users of the connected CRM platform. These are not the contacts or leads, but rather the user accounts from the connected CRM.
7 properties 4 required
Contact
object
Information about an individual affiliated with another CRM Object (e.g., a Lead, a Deal, etc)
11 properties 4 required
Address
object
5 properties
Deal
object
(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 Accou…
14 properties 6 required
Account
object
(Alias: company, organization) An organization involved with your business.
13 properties 4 required
Lead
object
A Lead represents an individual, or sometimes an organization, that is interested in purchasing your product (i.e., is a potential Deal). CRM Caveats: - HubSpo…
12 properties 4 required
Note
object
A Note attached to some CRM Object.
7 properties 4 required
Task
object
A task attached to some CRM object
11 properties 4 required
Event
object
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,…
12 properties 4 required
EventAttendee
object
Event Attendees hold information about someone who attendee or was invited to an event. Attendees are always associated with some Event and another person obje…
8 properties 5 required
Field
object
(Alias: property) A field is a key-value pair on a CRM Object that provides information about that object.
11 properties 8 required
Email
object
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 pers…
17 properties 7 required
Call
object
10 properties
CallCreate
object
7 properties 3 required
CallUpdate
object
3 properties 1 required
EmailCreate
object
12 properties 3 required
EmailUpdate
object
4 properties
EventAttendeeCreate
object
5 properties 2 required
EventAttendeeUpdate
object
2 properties
EventCreate
object
9 properties 2 required
EventUpdate
object
9 properties
TaskCreate
object
8 properties
TaskUpdate
object
8 properties
ContactUpdate
object
Update a Contact.
8 properties
ContactCreate
object
Properties that a contact can be created with
8 properties 1 required
DealUpdate
object
7 properties 1 required
DealCreate
object
7 properties 2 required
AccountUpdate
object
10 properties 1 required
AccountCreate
object
10 properties 1 required
NoteCreate
object
Create a new Note. You may only associate a note with at most one entity of each type upon creation.
4 properties
NoteUpdate
object
Update an existing Note. Please note that updating associations is not currently supported.
4 properties
LeadUpdate
object
8 properties
LeadCreate
object
8 properties 1 required
CustomFieldCreate
object
5 properties 2 required
ListWithAssociations
object
A List or View in a CRM
6 properties 5 required
ListWithoutAssociations
object
A List or View in a CRM
5 properties 4 required
StringFilter
object
8 properties
BooleanFilter
object
2 properties
NumberFilter
object
8 properties
StringListFilter
object
4 properties
DateFilter
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vessel-crm-openapi.yml Raw ↑

Other APIs Vessel publishes across the network.

Vessel Platform API
Vessel Sales Engagement Unified API
Vessel Chat Unified API
Vessel Dialer Unified API
Vessel Marketing Automation Unified API
Vessel CRM API (v1, legacy)
Vessel Engagement API (v1, legacy)
Vessel Salesforce Actions API
Vessel Slack Actions API
Vessel Microsoft Teams Actions API
Vessel Outreach Actions API
Vessel Salesloft Actions API
Where this information came from

This is an independent, third-party profile of Vessel CRM Unified API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.