An activity record can have an optional client contact. This API lists valid client contacts.
Client Contact Lookup
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | activities.json | |
| General | Yes | Parameters described in API syntax section | Structure of an API call | |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action=clientcontacts | |
| Client | Yes | Client code | client=1/ada0001 |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/activities.json?&company=1&action=clientcontacts&client=1/ada0001&version=6
Example request (legacy username/password):
http://<SERVER>/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
}
]
}