The engActions API from Vessel — 3 operation(s) for engactions.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vessel-engactions-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Reference Eng Actions API
version: '2.0'
summary: API
description: "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:\n\nKey | Value | Description\n---------|----------|----------\n vessel-api-token | `<VESSEL_API_TOKEN>` | The API token provided by us\n \nAdditionally, 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."
servers:
- url: https://api.vessel.land
security:
- VesselAPIToken: []
tags:
- name: engActions
paths:
/engagement/actions:
parameters: []
get:
summary: Get All Actions
tags:
- engActions
responses:
'200':
description: OK
content:
application/json:
schema:
title: responseBody
type: object
properties:
actions:
type: array
items:
$ref: '#/components/schemas/Action'
nextPageCursor:
type: string
examples:
example-1:
value:
actions:
- id: 2322707bbc41577d9806400e2daa25de
type: call
dueDate: '2019-09-24T14:15:22Z'
status: complete
completedTime: '2019-08-24T14:15:22Z'
modifiedTime: '2019-08-24T14:15:22Z'
createdTime: '2019-08-24T14:15:22Z'
associations:
contactId: e5f32d4fd2115220bd20a2ccf81210ec
callId: 0dcb45e051315a6ea63b0f16e73689d9
emailId: d08f345ace24509e911a0ea8e3d2203c
ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
additional: {}
nextPageCursor: string
operationId: get-all-engagement-actions
parameters:
- $ref: '#/components/parameters/accessToken'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/allFields'
description: Retrieve all Actions
/engagement/action:
parameters: []
get:
summary: Get Action
tags:
- engActions
responses:
'200':
description: OK
content:
application/json:
schema:
title: responseBody
type: object
properties:
action:
$ref: '#/components/schemas/Action'
examples:
example-1:
value:
action:
id: 2322707bbc41577d9806400e2daa25de
type: call
dueDate: '2019-09-24T14:15:22Z'
status: complete
completedTime: '2019-08-24T14:15:22Z'
modifiedTime: '2019-08-24T14:15:22Z'
createdTime: '2019-08-24T14:15:22Z'
associations:
contactId: e5f32d4fd2115220bd20a2ccf81210ec
callId: 0dcb45e051315a6ea63b0f16e73689d9
emailId: d08f345ace24509e911a0ea8e3d2203c
ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
additional: {}
operationId: get-one-engagement-action
parameters:
- $ref: '#/components/parameters/accessToken'
- $ref: '#/components/parameters/id'
- $ref: '#/components/parameters/allFields'
description: Retrieve a Action by Id.
/engagement/action/complete:
parameters: []
post:
summary: Complete Action
tags:
- engActions
x-speakeasy-name-override:
methodNameOverride: complete
operationId: post-complete-engagement-action
responses:
'200':
description: OK
content:
application/json:
schema:
title: responseBody
type: object
properties:
id:
type: string
examples:
example-1:
value:
id: '0'
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
accessToken:
type: string
fields:
$ref: '#/components/schemas/ActionComplete'
required:
- id
- accessToken
- fields
examples:
example-1:
value:
id: 939f3f91233b4b0e8f0f2a0f2a0f2a0f
accessToken: string
fields:
type: call
durationSeconds: 120
phone: '8192223333'
body: Call went well, they'll likely buy our paper.
dispositionKey: answered_meeting_set
description: Complete an action to move a prospect to the next step of a sequence.
components:
parameters:
cursor:
name: cursor
in: query
description: The cursor to use for pagination
schema:
type: string
id:
name: id
in: query
description: The id of the object to retrieve
required: true
schema:
type: string
accessToken:
name: accessToken
in: query
description: The token for the customer's account. This was generated when they connected their account.
required: true
schema:
type: string
allFields:
name: allFields
in: query
description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response
schema:
type: boolean
limit:
name: limit
in: query
description: The number of records to return per page.
schema:
type: number
schemas:
ActionComplete:
title: ActionComplete
type: object
examples:
- type: call
durationSeconds: 120
phone: '8192223333'
body: Call went well, they'll likely buy our paper.
dispositionKey: answered_meeting_set
description: Complete a call or other action to move a prospect in a sequence to the next step.
properties:
type:
type: string
enum:
- call
- other
description: The type of the action that was completed. Only call and other actions are currently supported.
body:
type: string
durationSeconds:
type: number
description: Supported for call actions. How long the call lasted, in seconds.
phone:
type: string
description: Supported for call actions. The phone number called.
dispositionKey:
type: string
description: Supported for call actions. The key of the disposition selected for the call. Call /call-dispositions for possible values.
Action:
title: Action
type: object
description: An action represents some work that needs to be done in order to progress a sequence to the next step.
examples:
- id: 2322707bbc41577d9806400e2daa25de
type: call
dueDate: '2019-09-24T14:15:22Z'
status: complete
completedTime: '2019-08-24T14:15:22Z'
modifiedTime: '2019-08-24T14:15:22Z'
createdTime: '2019-08-24T14:15:22Z'
associations:
contactId: e5f32d4fd2115220bd20a2ccf81210ec
callId: 0dcb45e051315a6ea63b0f16e73689d9
emailId: d08f345ace24509e911a0ea8e3d2203c
ownerUserId: 56f653659ea9524b9e0fb0ba67e6f8a0
additional: {}
properties:
id:
type: string
description: Id of the object in the connected Engagement Platform.
dueDate:
type: string
type:
type: string
enum:
- call
- email
- other
status:
type: string
enum:
- in_progress
- complete
- to_do
createdTime:
type: string
description: The timestamp that the action was created
modifiedTime:
type: string
description: The timestamp the action was last modified
associations:
type: object
required:
- callId
- contactId
- emailId
- ownerUserId
properties:
callId:
type: string
contactId:
type: string
emailId:
type: string
ownerUserId:
type: string
description: The Id of the User that owns this Action
additional:
type: object
description: Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream Engagement Platform
required:
- id
- createdTime
- modifiedTime
- associations
securitySchemes:
VesselAPIToken:
name: vessel-api-token
type: apiKey
in: header
x-speakeasy-name-override:
- operationId: post-*
methodNameOverride: create
- operationId: put-*
methodNameOverride: update
- operationId: delete-*
methodNameOverride: delete
- operationId: get-one-*
methodNameOverride: find
- operationId: get-all-*
methodNameOverride: list
- operationId: get-details-*
methodNameOverride: details
- operationId: get-batch-*
methodNameOverride: batch
- operationId: search-*
methodNameOverride: search