Clients lookup list
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | jobs.json | |
General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
Company | Yes | The company number | company=1 | |
Action | Yes | The action to perform | action=clients | |
Client type | Yes | Filter list by client type | clienttype=b2b2 |
It is also possible to filter the returned data by passing a view. See Using views.
Example request:
http://<SERVER>/jsonapi/jobs.json?company=1&user=user&password=user&action=clients&page=1&rows=10&version=3.9&clienttype=b2b2
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 10,
"pagenumber": 1,
"success": true,
"data": [
{
"clientUuid": "FC9D9C69E9998949B471FCC5264CEC8F",
"clientTimeStampModified": 1522329200,
"clientRecordVersionNumber": 105,
"clientCustomField196": "",
"clientCustomField204": "",
"clientCustomField211": "0000-00-00",
"clientCustomField260": "",
"clientCustomField296": "",
"clientCustomField315": false,
"clientCustomField323": "",
"clientCode": "1/AMT0",
"clientName": "Amos Ltd",
"clientCategoryName": "Client",
"clientPhone": "",
"clientCategory": 3,
"clientHandlerUserID": 499,
"clientWebURL": "",
"clientEmail": "",
"clientInactive": false,
"clientType": "B2B2",
"clientOpStatus": "Gold",
"clientMarketSector": "Media",
"clientOnHold": false,
"clientHandlerFullName": "Adele Clarke"
}
]
}