Returns a single client contact record
| 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=clientcontactdetails | 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 | |
| Identifier | Yes | Contact ID | clientcontact=142 |
Example request:
http://<SERVER>/jsonapi/clientcontacts.json?user=user&password=user&version=3.9&company=1&modelstructure=clientcontactdetails&clientcontact=142
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"clientcontactuuid": "B47402D2DAB94DCAA78E01DF8F07808E",
"clientcontactTimeStampModified": 1536228215,
"clientcontactRecordVersionNumber": 12,
"clientcontactCustomField200": "label 1",
"clientcontactCustomField206": "a",
"clientcontactCustomField210": "2013-06-27",
"clientcontactCustomField253": "",
"clientcontactCustomField289": "",
"clientcontactCustomField314": "",
"clientcontactCustomField326": 0,
"clientcontactInternalRef": 142,
"clientcontactClientCode": "1/F001",
"clientcontactTitle": "- Blank -",
"clientcontactFirstName": "Babs ",
"clientcontactMiddleInitials": "",
"clientcontactName": "Smith",
"clientcontactFullName": "Babs Smith",
"clientcontactBackwardsFullName": "Smith, Babs ",
"clientcontactJobTitle": "Head of procurement",
"clientcontactSalutation": "Mrs",
"clientcontactCellPhone": "01791 663 337",
"clientcontactDirectTelephone": "01625 777 222",
"clientcontactOtherPhone": "01625 777 225",
"clientcontactSecondaryPhone": "01625 777 223",
"clientcontactClientPhone": "0161 467 1897",
"clientcontactFax": "01625 777 224",
"clientcontactEMail": "[email protected]",
"clientcontactAdd1": "here.com",
"clientcontactAdd2": "30, ",
"clientcontactAdd3": "Shridgley road,",
"clientcontactAdd4": "Bolington",
"clientcontactAdd5": "Cheshire",
"clientcontactAdd6": "SK10 5RD",
"clientcontactAdd7": "England",
"clientcontactInactive": false,
"clientcontactInterests": "test note",
"clientcontactOptIn": false,
"clientcontactOptInDate": "0000-00-00",
"clientcontactOptInTime": "00:00:00",
"clientcontactOptInUserid": 0,
"clientcontactOptInBy": "",
"clientcontactVerifiedBy": "",
"clientcontactOptInTimezone": "",
"clientcontactOptInDateUtc": "0000-00-00",
"clientcontactOptInTimeUtc": "00:00:00",
"clientcontactOptInSource": "",
"clientcontactOptInNotes": "",
"clientcontactOptInVerified": false,
"clientcontactOptInVerifiedDate": "0000-00-00",
"clientcontactOptInVerifiedDateUtc": "0000-00-00",
"clientcontactOptInVerifiedTimezone": "",
"clientcontactOptInVerifiedTime": "00:00:00",
"clientcontactOptInVerifiedTimeUtc": "00:00:00",
"clientcontactOptInVerifiedUserid": 0,
"clientcontactOptOutCellPhone": false,
"clientcontactOptOutEmail": false,
"clientcontactOptOutMail": false,
"clientcontactOptOutPhone": true,
"clientcontactOptOutSms": false
}
]
}
Note: Feature from API 2.2