List the officer appointments
Request
GET https://api.company-information.service.gov.uk/officers/{officer_id}/appointments
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| officer_id | string | The officer id of the appointment list being requested. | |
| items_per_page | integer | The number of appointments to return per page. | Optional. |
| start_index | integer | The first row of data to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the items_per_page parameter. | Optional. |
Request headers
This method does not require specific header parameters.
Request body
This method does not take any request body parameters.
Authentication
Not required.
Response
Response headers
If successful, the method returns the following headers:
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| ETag | The ETag of the resource. |
Response body
If successful, this method returns a appointmentList resource in the body.
Status codes
The following HTTP status codes may be returned, optionally with a response resource:
| Status code | Description | Response Resource |
|---|---|---|
| 401 | Not authorised | error |
| 400 | Bad request | error |
CURL example
curl -uYOUR_APIKEY_FOLLOWED_BY_A_COLON: https://api.company-information.service.gov.uk/officers/{officer_id}/appointments
