List

Overall list of contact personsOverall list of contact persons

GET https://do.workzeal.com/contact/list?page=1&records_onpage=50

Returns contact persons across all clients, paginated, from newest to oldest, together with their phones, email addresses, and social networks. You can filter by name:

GET https://do.workzeal.com/contact/list?name=Smith

Query ParametersQuery Parameters

List of a client's contact personsList of a client's contact persons

GET https://do.workzeal.com/contact/list?company_id=368132

Returns all contact persons of one client with their communication channels. When company_id is passed, the other parameters are not used.

Query ParametersQuery Parameters

ExampleExample

curl --location --request GET 'https://do.workzeal.com/contact/list?company_id=368132' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX'

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://do.workzeal.com/contact/list?company_id=368132',
  'headers': {
    'Authorization': 'Bearer XXXX-XXXXXXX-XXXXXXX'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

ResponseResponse

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "[ { ...contact person with Phones/Emails... }, ... ]"
}
// value - JSON array of contact persons with their phones and email addresses