- User
- Get All Users
User
Get All Users
Retrieve all Users
GET
/engagement/users
vessel-api-token*
curl --request GET \
--url https://api.vessel.land/engagement/users \
--header 'vessel-api-token: AUTH_VALUE'curl --request GET \
--url https://api.vessel.land/engagement/users \
--header 'Content-Type: application/json' \
--header 'vessel-api-token: '
Parameters
accessTokenRequired
string
The token for the customer's account. This was generated when they connected their account.
cursor
string
The cursor to use for pagination
limit
number
The number of records to return per page.
allFields
boolean
Returns all fields including non-unifiable and custom fields under the "additional" property in the response
Response
users
array
nextPageCursor
string
curl --request GET \
--url https://api.vessel.land/engagement/users \
--header 'Content-Type: application/json' \
--header 'vessel-api-token: '