List of Companies
GET {{baseUrl}}/cas/companies?offset={{offset}}&limit={{limit}}&details={{details}}
Gets a list of all non-deleted companies which the user has access to.
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|---|---|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
| details | String | Optional | Example = true |
Response Body
Returns a list containing object as defined below
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | String | Yes | |
| name | String | Yes | |
| number | String | No | Must be a valid ACN |
| incorporationDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| annualReviewDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| businessNumber | Number | No | ABN / NZBN |
| registrationState | String | No | Must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT' |
| jurisdiction | String | Yes | Currently only 'Australia' is allowed |
| type | Object | No | See table below |
| agentId | Number | No | |
| registered | boolean | Yes | false companies will show up in company registrations |
type object
Note: Within Australia, only certain combinations of companyType, companyClass and companySubClass are valid
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| companyType | String | Yes | Must be one of 'Small Proprietary'/'Large Proprietary'/'Public Company' |
| companyClass | String | Yes | Must be one of 'Limited by Shares'/'Limited by Guarantee'/'Limited by Shares and Guarantee'/'Unlimited'/'No Liability' |
| companySubClass | String | Yes | Must be one of 'None'/'Superannuation Trustee Company'/'Non Profit Company'/'Home Unit Company'/'Listed'/'Unlisted'/'Section 150 License'/'Unlisted Non Profit |
details object (Optional Paramter)
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| asicAgentNumber | String | No | |
| annualReviewStatus | String | Yes | |
| annualReviewStatusDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| labels | String[] | No | Name of labels associated with the company |
Additional keys
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| offset | Number | Yes | |
| limit | Number | Yes | |
| total | Number | Yes |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | string | ||
limit | string | The maximum range is 500. | |
details | string | enabling this option will display Annual Review Date, Annual Review Status, Annual Review Status Date, ASIC agent number and labels for all the companies. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"companies":[{"agentId":9,"annualReviewDate":"2018-10-03","businessNumber":null,"details":{"annualReviewStatus":"PROCESSED","annualReviewStatusDate":null,"asicAgentNumber":null,"labels":[]},"id":"1f2ccd6c-7c24-42ca-8cf2-496d7b112cea","incorporationDate":"2017-10-02","jurisdiction":"Australia","name":"Jasmine's Sour Ale Proprietary Limited","number":"000000113","registrationState":"VIC","registered":true,"type":{"companyClass":"Limited by Shares","companySubClass":"None","companyType":"Small Proprietary"}},{"agentId":9,"annualReviewDate":"2018-10-04","businessNumber":null,"details":{"annualReviewStatus":"PROCESSED","annualReviewStatusDate":null,"asicAgentNumber":null,"labels":[]},"id":"26568029-fb4c-4ade-ad5b-ce6508c0329f","incorporationDate":"2017-10-04","jurisdiction":"Australia","name":"Menoetius - Hestia Group Pty. Limited.","number":"000000019","registrationState":"ACT","registered":true,"type":{"companyClass":"Limited by Shares","companySubClass":"None","companyType":"Small Proprietary"}}],"limit":500,"offset":0,"total":2}