sequences
To get the sequences and steps of a user
get/v1/sequences
Request
- Base URLhttps://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
sequenceNamestring
Search by Sequence title
pageSizenumber
The number of items per page in the result. Maximum pageSize is 1000
pagenumber
The page number for pagination.
sort'ASC' | 'DESC'
The sorting order for the result.
sortBy'sequence.createdAt' | 'sequence.title'
The field by which the result should be sorted.
clientIdsstring
Response
Successfully fetched all sequences and their associated steps
Example response
{
"message": "Successfully fetched all sequences and their associated steps",
"payload": [
{
"id": "JA5YdAr9wy",
"title": "Sample Sequence",
"active": true,
"steps": [
{
"id": "bwOLEx4l8G",
"name": "Step 1"
}
],
"client": {
"id": "g9bzZq4aMd",
"companyName": "Demo",
"firstName": "John",
"lastName": "Doe"
},
"user": {
"id": 1,
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com"
}
}
]
}Changes
No recorded changes to this operation across all 4 revisions of this API.