List of officers
GET {{baseUrl}}/companies/:companyId/officers?offset={{offset}}&limit={{limit}}&all={{showallofficers}}
Returns a list of officers for a company
Response Body
Returns a list of objects that will contain the below keys
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| alternateContactId | Number | No | This is the contactID of the existing director\Mandatory if the position is 'Alternate' |
| alternateTerms | String | No | Terms of Alternate appointmentMandatory if the position is 'Alternate' |
| appointDate | Date | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Cannot be after ‘ceaseDate’ |
| ceaseDate | Date | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Only if positionStatus is present and is not ‘Appointed’. Cannot be before ‘appointDate’ |
| companyId | Number | Yes | Must be an ID of an existing company. |
| contactId | Number | Yes | Must be ID of an existing contact |
| id | Number | Yes | Must be ID of an existing Officer transaction |
| nominatorContactId | Number | No | This is the contactID of the existing director\Mandatory if the position is 'Nominee Director' |
| notes | String | No | Text |
| position | String | Yes | Must be one of 'Director','Secretary', 'Alternate', Managing Director, Manager, Nominee Director, |
| positionStatus | String | No | Must be one of 'Appointed, Resigned, Removed, Deceased' |
| prepareForm | Boolean | No | True or False |
| signatoryStatus | String | No | Must be one of 'Attendee, Signatory, Chairperson, Form Signatory, Apology, Non Attendee' |
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 | ||
all | string | [OPTIONAL] - true/false to show all officers (e.g. including deceased/removed/resisnged) |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"companyId":"af99c0f0-81b1-462e-a925-891b886a88e2","limit":2,"officers":[{"alternateContactId":null,"alternateTerms":null,"appointDate":"2022-03-07","ceaseDate":null,"contactId":1800189,"id":1963443,"nominatorContactId":null,"notes":null,"position":"Director","positionStatus":"Appointed","prepareForm":false,"signatoryStatus":"Chairperson"}],"offset":0,"total":1}