Client Contact Lookup

An activity record can have an optional client contact. This API lists valid client contacts.

Client Contact Lookup

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaactivities.json
GeneralYesParameters described in API syntax sectionStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=clientcontacts
ClientYesClient codeclient=1/ada0001

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/activities.json?&company=1&action=clientcontacts&client=1/ada0001&version=6

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/activities.json?&company=1&action=clientcontacts&client=1/ada0001&version=6&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 2,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "clientcontactInternalRef": 6841,
      "clientcontactFullName": "James Smith-",
      "variable_selected": true
    },
    {
      "clientcontactInternalRef": 6821,
      "clientcontactFullName": "Harry Hill",
      "variable_selected": false
    }
  ]
}