Lists
Get List
Lists
Get List
Retrieve a single List by Id
curl --request GET \
--url https://app.vessel.dev/crm/list \
--header 'vessel-api-token: <vessel-api-token>' \
--header 'x-vessel-api-token: <x-vessel-api-token>'
{
"list": [
{
"associations": [
{
"contactIds": [
"v.contact.e5f32d4fd2115220bd20a2ccf81210ec",
"v.contact.2d20a2ccf81210ecddf32d4fd2115221"
]
}
],
"createdTime": "2019-08-24T14:15:22Z",
"id": "006b4db16b6b50c981a174b02753c390",
"modifiedTime": "2019-08-24T14:15:22Z",
"name": "California Leads",
"nativeId": "34"
}
],
"nextPageCursor": "string"
}
curl --request GET \
--url https://api.vessel.land/crm/list?objectType=contact&id=11&cursor=string \
--header 'Content-Type: application/json' \
--header 'vessel-api-token: '
CRM Caveats
Supported for HubSpot, Salesforce and Zoho
Authorizations
vessel-api-token[header]required
string
Query Parameters
accessTokenrequired
string
The token for the customer's CRM account. This was generated when they connected their account.
objectTyperequired
string
The object type for the Lists
idrequired
string
cursor
string
Provide the nextPageCursor
value from the previous request to retrieve the next set of ids
allFields
boolean
Returns all fields including non-unifiable and custom fields under the "additional" property in the response
Response
list
object
A List or View in a CRM
nextPageCursor
string
curl --request GET \
--url https://api.vessel.land/crm/list?objectType=contact&id=11&cursor=string \
--header 'Content-Type: application/json' \
--header 'vessel-api-token: '
{
"list": [
{
"associations": [
{
"contactIds": [
"v.contact.e5f32d4fd2115220bd20a2ccf81210ec",
"v.contact.2d20a2ccf81210ecddf32d4fd2115221"
]
}
],
"createdTime": "2019-08-24T14:15:22Z",
"id": "006b4db16b6b50c981a174b02753c390",
"modifiedTime": "2019-08-24T14:15:22Z",
"name": "California Leads",
"nativeId": "34"
}
],
"nextPageCursor": "string"
}