Client list

Clients

If you wish to access multiple client records you would normally use the clientslist model

For more details about using models see Using data models

For clients two models are available:

clientslist
clientdetails
clientfinancial

If a list of records is required a ‘view’ parameter should be passed. If no ‘view’ parameter is passed all records for the synergist company are returned.

Parameter	Description	Example	More info
API	The API area	clients.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=clientslist	Using data models
View	Stored filter applied	view=-1001	Using views
Sort	Change the view's default sort order	sort=CLIENT	Sorting
Filters	Filter by a key field		Filters
Response	Returned data	A JSON string containing the data

Example request:
Request for data (list of records using specified model)

http://<SERVER>/jsonapi/clients.json?company=1&version=3.3&user=user&password=user&company=1&style=modeldata&modelstructure=clientslist&view=-1001

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 502,
  "totalpages": 251,
  "responsemessage": "",
  "pagerows": 2,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "clientUuid": "A246FBB5E59C41A1AC29A00A8F82FC66",
      "clientTimeStampModified": 1518195468,
      "clientRecordVersionNumber": 105,
      "clientCustomField323": "",
      "clientCode": "1/GS",
      "clientName": "Great Sites",
      "clientCategoryName": "Client",
      "clientPhone": "",
      "clientCategory": 3,
      "clientHandlerUserID": 121,
      "clientWebURL": "",
      "clientEmail": "",
      "clientInactive": false,
      "clientType": "",
      "clientOpStatus": "",
      "clientMarketSector": "B2B",
      "clientOnHold": false,
      "clientHandlerFullName": "Alan Shearer (mike email)"
    },
    etc. etc.
    {