clients

Fetch all clients

get/v1/clients

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.

Field to sort the results by. If not selected, default sorting is done by createdAt.

Response

Successfully fetched client list<br><br>

{"stackTrail":"paths:/v1/clients:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"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"}]}}}

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 endpoint across all 1 revision of this API.