List of Companies by Label ID
GET {{baseUrl}}/cas/labels/{{labelId}}/companies?offset={{offset}}&limit={{limit}}
Returns a list of all companies which the user has access to and are assigned to the label in the query.
Query Parameters
Form Parameter | type | Mandatory | Description |
---|---|---|---|
offset | number | Required | Example = 0 |
limit | number | Required | Example = 500 |
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 |
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 |
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
offset | string | number | |
limit | string | number |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |