API version 2 Companies
1. List companies (api2/companies)
This method will answer with a collection of IInsight's companies in JSON format.
The results would be paginated, having a maximum of 100 records per page. An empty collection and a status code 200 response, means that there is no records in the specified page.
URL
| Server | URL | HTTP type |
|---|---|---|
| UAT | https://api-aus-uat.iinsightonline.com/api2/companies | GET |
| PRODUCTION | https://api-aus.iinsightonline.com/api2/companies | GET |
Authorization
| Parameter | Value | Mandatory |
|---|---|---|
| Type | Bearer Token | Yes |
| Token | The token is generated using the /auth/login method | Yes |
Query Params
| Parameter | Value | Mandatory |
|---|---|---|
| page | The page number of the paginated results. (i.e.: 1) |
Yes |
| status | The status of the company. (i.e.: active / inactive / all) | Yes |
| modified_since |
Date since last update or insert. Format: YYYY-MM-DDThh:mm:ssZ (date and time in UTC ISO 8601) Example: 2024-02-29T12:28:01Z Note: This field is not mandatory, you can skip this field to get all companies without restrictions on creation or modification date. |
No |
Response
[
{
"company_id": "659",
"company_name": "test cmp 12",
"email" ; "email@email.com",
"phone1": "123456789",
"phone2": "",
"fax": "",
"mobile": "",
"street": null,
"postcode": null,
"suburb": null,
"sublocality": null,
"state": null,
"country": null,
"bank": "",
"branch": "",
"abn": "",
"biller_id": "aaaaa",
"notes": "",
"last_update": "08-06-2024 01:02:13",
"last_update_utc": "2024-06-07T15:02:13Z",
"status": "active" // (active | inactive)
}
]