List of client contacts
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | clientcontacts.json | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
| Model Structure | Yes | Name of model required | modelstructure=clientcontactslist | Using data models |
| View | No | Stored filter applied | Using views | |
| Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 |
Example request:
http://<SERVER>/jsonapi/clientcontacts.json?user=user&password=user&version=3.9&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