BETA This is a new service.

Request

GET https://api.companieshouse.gov.uk/officers/{officer_id}/appointments

Query parameters

Parameter nameValueDescriptionAdditional
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 nameValueDescriptionAdditional
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 codeDescriptionResponse Resource
401 Not authorised error
400 Bad request error

CURL example

curl -uYOUR_APIKEY_FOLLOWED_BY_A_COLON: https://api.companieshouse.gov.uk/officers/{officer_id}/appointments

Explore this API

officer_id The officer id of the appointment list being requested.
items_per_page The number of appointments to return per page.
start_index The first row of data to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the items_per_page parameter.

To explore this api, you must be signed in and have registered for at least one API key. Registration takes a few seconds, and allows you to explore the API from right here in the web page!

You can create an API key through Your Applications page.