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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vessel

Vessel Engagement API (v1, legacy)

The first-generation Vessel Sales Engagement API, published under /engagement/* on api.vessel.land. Covers users, accounts, contacts, tasks, actions, calls, emails, call dispositions, sequences, sequence steps and mailboxes, plus the Link and connection endpoints. Superseded by the v2 engagement unification surface. Published by Vessel as OpenAPI 3.1.0 with 44 operations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Vessel Engagement API (v1, legacy) is one of 20 APIs that Vessel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sales Engagement, Legacy, v1, Sequences, and Mailboxes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a GitHub repository.

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

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

44 operations 35 paths 71 schemas 2 DELETE23 GET3 PATCH16 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.land
Authentication
API Key
Resource Areas
19

Authentication & Security 1

Vessel Engagement API (v1, legacy) 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 44

Across 35 paths, the API surfaces 44 operations — 2 DELETE, 23 GET, 3 PATCH, 16 POST. They span 19 resource areas, including engUsers, engAccounts, engAccountss, engContacts, engCustomFields, engTasks, engActions, engCalls, and 11 more. Each is listed below with its method, path, parameters, and response codes.

engUsers 2
GET
/engagement/users
Get All Users
get-all-engagement-users 4 params → 200
GET
/engagement/user
Get User
get-one-engagement-user 3 params → 200
engAccounts 4
GET
/engagement/accounts
Get All Accounts
get-all-engagement-accounts 4 params → 200
GET
/engagement/account
Get Account
get-one-engagement-account 3 params → 200
POST
/engagement/account
Create Account
post-engagement-account body → 200
PATCH
/engagement/account
Update Account
put-engagement-account body → 200
engAccountss 1
POST
/engagement/accounts/search
Search Accounts
search-engagement-account body → 200
engContacts 5
GET
/engagement/contacts
Get All Contacts
get-all-engagement-contacts 4 params → 200
GET
/engagement/contact
Get Contact
get-one-engagement-contact 3 params → 200
POST
/engagement/contact
Create Contact
post-engagement-contact body → 200
PATCH
/engagement/contact
Update Contact
put-engagement-contact body → 200
POST
/engagement/contacts/search
Search Contacts
search-engagement-contact body → 200
engCustomFields 2
GET
/engagement/contact/custom-fields
Get All Custom Fields
get-all-engagement-customFields → 200
POST
/engagement/contact/custom-field
Create Custom Field
post-engagement-customFields body → 200
engTasks 5
GET
/engagement/tasks
Get All Tasks
get-all-engagement-tasks 4 params → 200
GET
/engagement/task
Get Task
get-one-engagement-task 3 params → 200
POST
/engagement/task
Create Task
post-engagement-task body → 200
PATCH
/engagement/task
Update Task
put-engagement-task body → 200
POST
/engagement/task/complete
Complete Task
post-complete-engagement-task body → 200
engActions 3
GET
/engagement/actions
Get All Actions
get-all-engagement-actions 4 params → 200
GET
/engagement/action
Get Action
get-one-engagement-action 3 params → 200
POST
/engagement/action/complete
Complete Action
post-complete-engagement-action body → 200
engCalls 2
GET
/engagement/calls
Get All Calls
get-all-engagement-calls 4 params → 200
GET
/engagement/call
Get Call
get-one-engagement-call 3 params → 200
engEmails 3
GET
/engagement/emails
Get All Emails
get-all-engagement-emails 4 params → 200
GET
/engagement/email
Get Email
get-one-engagement-email 3 params → 200
POST
/engagement/emails/search
Search Emails
search-engagement-email body → 200
engDispositions 1
GET
/engagement/call-dispositions
Get All Call Dispositions
get-all-engagement-callDispositions 4 params → 200
engSequences 4
GET
/engagement/sequences
Get All Sequences
get-all-engagement-sequences 4 params → 200
POST
/engagement/sequence/start
Start Sequence
post-start-engagement-sequence body → 200
POST
/engagement/sequence
Create Sequence
post-engagement-sequences body → 200
POST
/engagement/sequence/step
Create Sequence Step
post-engagement-sequences-steps body → 200
engMailboxes 1
GET
/engagement/mailboxes
Get All Mailboxes
get-all-engagement-mailboxes 4 params → 200
engPassthrough 1
POST
/engagement/passthrough
Passthrough Request
post-engagement-passthrough body → 200
tokens 1
POST
/link/token
Create Link Token
post-link-token → 200
links 1
POST
/link/exchange
Exchange Public Token for Access Token
post-link-exchange body → 200
connections 3
GET
/connection/connection
Get Connection
get-one-connection 1 param → 200
DELETE
/connection/connection
Delete Connection
delete-connection body → 200
GET
/connection/connections
Get All Connections
get-all-crm-connections → 200
integrations 1
GET
/connection/crm/integrations
Get CRM Integrations
get-all-crm-integrations → 200
Operations 1
GET
/connection/engagement/integrations
Get Engagement Integrations
get-all-engagement-integrations → 200
webhooks 3
GET
/connection/webhook
Get Webhook
get-one-webhook 2 params → 200
POST
/connection/webhook
Create Webhook
post-webhook body → 200
DELETE
/connection/webhook
Remove Webhook
delete-webhook body → 200

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are Email (18 properties), EmailCreate (16 properties), EngContact (16 properties), Deal (14 properties). Each schema is shown below with its type and property counts.

EngIntegration
object
3 properties
EmailEngAddress
object
3 properties
Phone
object
3 properties
EngAddress
object
6 properties
EngAccount
object
(Alias: company, organization) An organization involved with your business.
13 properties 4 required
EngUser
object
Users of the connected Engagement platform. These are not the contacts or leads, but rather the user accounts from the connected Engagement Platform.
8 properties 4 required
EngContact
object
An known individual affiliated with an Account, Deal, etc
16 properties 4 required
EngContactCustomField
object
4 properties 3 required
EngTask
object
A task attached to some object
9 properties 4 required
Action
object
An action represents some work that needs to be done in order to progress a sequence to the next step.
8 properties 4 required
Call
object
A phone call between a User and an external Contact
10 properties 4 required
EngEmail
object
A email between a User and an external Contact
11 properties 4 required
CallDisposition
object
The disposition of a call
6 properties 4 required
EngAccountCreate
object
Properties that an account can be created with
9 properties 1 required
EngAccountUpdate
object
Properties that an account can be update with
9 properties
EngContactCreate
object
Properties that a contact can be created with
7 properties
EngContactUpdate
object
Properties that a contact can be updated with
6 properties
EngContactCustomFieldCreate
object
1 property 1 required
ActionComplete
object
Complete a call or other action to move a prospect in a sequence to the next step.
5 properties
EngTaskComplete
object
Complete a call or other task.
5 properties
EngTaskCreate
object
Properties that a task can be created with
6 properties 4 required
EngTaskUpdate
object
Properties that a task can be updated with
3 properties
EngSequence
object
Properties that a sequence can be created with
12 properties
EngSequenceCreate
object
3 properties 2 required
EngSequenceStepSettingsCreate
object
4 properties
EngSequenceStepCreate
object
properties that a sequence step can be created with
5 properties 4 required
EngSequenceStart
object
Start a sequence
2 properties
EngMailbox
object
Mailboxes in the connected engagement platform. These are email accounts that outbound emails will be sent from.
6 properties
InvalidIds
array
Ids that didn't return anything. Will be an empty array if all Ids are valid.
User
object
Users of the connected CRM platform. These are not the contacts or leads, but rather the user accounts from the connected CRM.
9 properties 5 required
Contact
object
Information about an individual affiliated with another CRM Object (e.g., a Lead, a Deal, etc)
12 properties 5 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 8 required
Account
object
(Alias: company, organization) An organization involved with your business.
14 properties 5 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…
13 properties 5 required
Note
object
A Note attached to some CRM Object.
8 properties 5 required
Task
object
A task attached to some CRM object
12 properties 5 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,…
13 properties 5 required
EventAttendee
object
Event Attendees hold information about someone who attendeed or was invited to an event. Attendees are always associated with some Event and another person obj…
9 properties 6 required
Field
object
(Alias: property) A field is a key-value pair on a CRM Object that provides information about that object.
10 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…
18 properties 8 required
StringFilter
object
7 properties
BooleanFilter
object
2 properties
NumberFilter
object
8 properties
StringListFilter
object
4 properties
DateFilter
object
8 properties
EmailCreate
object
16 properties 3 required
EmailUpdate
object
4 properties
EventAttendeeCreate
object
6 properties 2 required
EventAttendeeUpdate
object
1 property
EventCreate
object
13 properties 2 required
EventUpdate
object
9 properties
TaskCreate
object
12 properties
TaskUpdate
object
8 properties
ContactUpdate
object
Update a Contact.
8 properties
ContactCreate
object
Properties that a contact can be created with
9 properties 1 required
DealUpdate
object
7 properties 1 required
DealCreate
object
7 properties 2 required
AccountUpdate
object
10 properties
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.
7 properties
NoteUpdate
object
Update an existing Note. Please note that updating associations is not currently supported.
3 properties
LeadUpdate
object
8 properties
LeadCreate
object
8 properties 1 required
CustomFieldCreate
object
4 properties 2 required
ListWithAssociations
object
A List or View in a CRM
7 properties 6 required
ListWithoutAssociations
object
A List or View in a CRM
6 properties 5 required
Integration
object
3 properties
WebhookMetadataCreate
object
Information describing a webhook
1 property
WebhookMetadata
object
4 properties
Connection
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vessel-engagement-v1-openapi.yml Raw ↑

Other APIs Vessel publishes across the network.

Vessel Platform API
AE Profile APIs.io
Vessel CRM Unified API
AE Profile APIs.io
Vessel Sales Engagement Unified API
AE Profile APIs.io
Vessel Chat Unified API
AE Profile APIs.io
Vessel Dialer Unified API
AE Profile APIs.io
Vessel Marketing Automation Unified API
AE Profile APIs.io
Vessel CRM API (v1, legacy)
AE Profile APIs.io
Vessel Salesforce Actions API
AE Profile APIs.io
Vessel Slack Actions API
AE Profile APIs.io
Vessel Microsoft Teams Actions API
AE Profile APIs.io
Vessel Outreach Actions API
AE Profile APIs.io
Vessel Salesloft Actions API
AE Profile APIs.io
#Sales Engagement#Legacy#v1#Sequences#Mailboxes
← Back to V APIs
API Details
ID
vessel:engagement-api-v1
Base URL
https://api.vessel.land
Docs
https://www.vessel.dev/
Provider
Vessel
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=engagement-api-v1&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/engagement-api-v1"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Vessel Engagement API (v1, legacy), 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.