List of organizations
Organizations
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | organizations.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Company | Yes | The company number | company=1 | |
| clientcode | No | Client code | clientcode=1/P0908 | |
| search | No | Search Criteria | search=test |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/organizations.json?&version=6&company=1
Example request (legacy username/password):
http://<SERVER>/jsonapi/organizations.json?&version=6&company=1&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"clientUuid": "A246FBB5E59C41A1AC29A00A8F82FC66",
"clientTimeStampModified": 1520523773,
"clientRecordVersionNumber": 107,
"clientCustomField196": "a",
"clientCustomField204": "yyzzz",
"clientCustomField211": "2018-03-07",
"clientCustomField260": "a - 1",
"clientCustomField296": "1ccccc",
"clientCustomField315": false,
"clientCustomField323": "Crunchy grass",
"clientCode": "1/P0908",
"clientName": "4imprint1",
"clientCategoryName": "Client",
"clientPhone": "",
"clientCategory": 3,
"clientHandlerUserID": 533,
"clientWebURL": "",
"clientEmail": "",
"clientInactive": false,
"clientType": "Food 1",
"clientOpStatus": "Silver",
"clientMarketSector": "Food and drink",
"clientOnHold": false,
"clientHandlerFullName": "Gina Labro"
}
]
}Note: Feature from API 2.2
