clients
Fetch all clients
get/v1/clients
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
searchstring
Search by First name, Last name, Email and Company name
pageSizenumber
Number of items per page. Maximum pageSize is 100
pagenumber
Page number for pagination.
sort'ASC' | 'DESC' required
Sort order for the results.
sortBy'createdDate' | 'firstName' | 'companyName' | 'activeSequence' | 'totalProspects' | 'emailSent' | 'activeEmailAccounts' required
Field to sort the results by. If not selected, default sorting is done by createdAt.
Response
Successfully fetched client list<br><br>
unknown required
Example response
{
"payload": {
"message": "Successfully fetched client list",
"payload": [
{
"id": "59pa8BRwy2",
"firstName": "John",
"lastName": "Doe",
"email": "johndoe+4@saleshandy.com",
"companyName": "Saleshandy",
"permission": "limited-access",
"createdDate": "2024-06-17T05:55:38.434Z",
"activeSequence": "0",
"totalProspects": "0",
"emailSent": "0",
"activeEmailAccounts": "0"
}
]
}
}Changes
No recorded changes to this operation across all 4 revisions of this API.