Contacts list

Client Contacts

The Contacts call retrieves a list of contacts within the specified view and company the user has access to.

Note: To access prospect or lead contacts you will need to create a special view and pass that as a view parameter.

Parameter	Description	Example	More info
API	The API area	clientcontacts.json
Action	Not required
General	Parameters described in overview	user=user&password=user	Overview
Company	Company number	company=1
Modelstructure	Name of model required	Modelstructure=clientcontactslist	Using data models
View	Stored filter applied	view=-1101	Using views
Sort	Change the view's default sort order	sort=NAME	Sorting
Filters	Filter by a key field	client=1/2365	Filters
Response	Returned data	A JSON string containing the data

Example request:
Request to list client contacts

http://<SERVER>/jsonapi/clientcontacts.json?user=user&password=user&version=3.3&company=1&style=modeldata&modelstructure=clientcontactslist&view=-1101

or with a timestamp filter ...

This will return any contact records created/modified in the past 15 mins.

http://<SERVER>/jsonapi/clientcontacts.json?user=user&password=user&version=3.3&company=3&style=modeldata&modelstructure=clientcontactdetails&timestampoffsetfrom=-900

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 7,
  "totalpages": 4,
  "responsemessage": "",
  "pagerows": 2,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "clientcontactuuid": "05F73F03055D4F0D942A7E03D0BA09EE",
      "clientcontactTimeStampModified": 1385819878,
      "clientcontactRecordVersionNumber": 7,
      "clientcontactCustomField200": "",
      "clientcontactCustomField206": "",
      "clientcontactCustomField210": "0000-00-00",
      "clientcontactCustomField253": "",
      "clientcontactCustomField289": "",
      "clientcontactCustomField314": "",
      "clientcontactCustomField326": 0,
      "clientcontactClientCode": "1/2365",
      "clientcontactClientName": "Capital Safety",
      "clientcontactClientCategory": "Client",
      "clientcontactEMail": "[email protected]",
      "clientcontactFullName": "{NO NAME IMPORTED}",
      "clientcontactInternalRef": 6535,
      "clientcontactJobTitle": "",
      "clientcontactPhone": ""
    },
    {
      "clientcontactuuid": "E4E9977BF7EAFC46AB3E9D6DBDEE2B0D",
      "clientcontactTimeStampModified": 1532619077,
      "clientcontactRecordVersionNumber": 0,
      "clientcontactCustomField200": "",
      "clientcontactCustomField206": "",
      "clientcontactCustomField210": "0000-00-00",
      "clientcontactCustomField253": "",
      "clientcontactCustomField289": "",
      "clientcontactCustomField314": "",
      "clientcontactCustomField326": 0,
      "clientcontactClientCode": "1/2365",
      "clientcontactClientName": "Capital Safety",
      "clientcontactClientCategory": "Client",
      "clientcontactEMail": "",
      "clientcontactFullName": "firstname",
      "clientcontactInternalRef": 8629,
      "clientcontactJobTitle": "",
      "clientcontactPhone": ""
    }
  ]
}

Note: Feature from API 2.2