Client Details

Returns a single client record

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

Example request:

http://<SERVER>/jsonapi/clients.json?company=1&version=3.7&user=user&password=user&company=1&style=modeldata&modelstructure=clientdetails&client=1/P0909

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "clientUuid": "493686EA86774194831FFE438B031917",
      "clientTimeStampModified": 1534507527,
      "clientRecordVersionNumber": 87,
      "clientCustomField196": "new item for list",
      "clientCustomField204": "111",
      "clientCustomField211": "2017-09-21",
      "clientCustomField260": "",
      "clientCustomField296": "1",
      "clientCustomField315": false,
      "clientCustomField323": "",
      "clientNotes": "",
      "clientCode": "1/P0909",
      "clientName": "",
      "clientStreet": "Hollins Park, Hollins Lane",
      "clientAddress1": "",
      "clientAddress2": "Warrington",
      "clientCounty": "http://www.synergist.co.uk",
      "clientPostcode": "WA2 8WA",
      "clientCountry": "",
      "clientCountryCode": "UK",
      "clientCountryName": "United Kingdom",
      "clientPhone": "",
      "clientFax": "",
      "clientHandlerUserID": 412,
      "clientHandlerFullName": "Matthew Test",
      "clientWebURL": "www.synergist.co.uk",
      "clientEmail": "",
      "clientISDN": "",
      "clientInternalClient": false,
      "clientInactive": false,
      "clientOPSourceClient": "Advertisment",
      "clientType": "",
      "clientEmployees": "",
      "clientOpStatus": "",
      "clientMarketSector": "Arts, Sport, Entertainment1",
      "clientDefaultSpec": "",
      "clientLeadRating": "",
      "clientOnHold": false,
      "clientTimeZoneCode": "UTCA",
      "clientTimezoneDescription": "",
      "clientCompanyNumber": 1
    }
  ]
}

Note: needs 12.2 for custom fields