Request

GET https://api.company-information.service.gov.uk/company/{company_number}/appointments/{appointment_id}

Query parameters

Parameter nameValueDescriptionAdditional
company_number string The company number of the officer list being requested.
appointment_id string The appointment id of the company officer appointment being requested.

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 officerSummary 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.company-information.service.gov.uk/company/{company_number}/appointments/{appointment_id}

Explore this API

company_number The company number of the officer list being requested.
appointment_id The appointment id of the company officer appointment being requested.

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.