Contacts List

List of client contacts

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaclientcontacts.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
Model StructureYesName of model requiredmodelstructure=clientcontactslistUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=CLIENTSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1

Example request:

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

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