List of companies
Company List
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | companies.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/companies.json?&version=6
Example request (legacy username/password):
http://<SERVER>/jsonapi/companies.json?&version=6&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 30,
"totalpages": 15,
"responsemessage": "",
"pagerows": 2,
"pagenumber": 1,
"success": true,
"data": [
{
"companyUuid": "94C589543730DA46A2AA1039D0A0B3E6",
"companyModified": 1508488482,
"companyRecordVersionNumber": 7,
"companyDefault": false,
"companyNumber": 255,
"companyName": "AAA Test Company",
"companyCountry": "UK",
"companyTimeZoneCode": "UTCA"
},
{
"companyUuid": "549696B601764BED8A80F229A5BC97BA",
"companyModified": 1520603827,
"companyRecordVersionNumber": 131,
"companyDefault": false,
"companyNumber": 9,
"companyName": "ArchitectX",
"companyCountry": "UK",
"companyTimeZoneCode": "UTCA"
}
]
}Note: Feature from API 2.2
