BETA This is a new service.

Request

GET https://api.companieshouse.gov.uk/search/officers

Query parameters

Parameter nameValueDescriptionAdditional
q string The term being searched for.
items_per_page integer The number of search results to return per page. Optional.
start_index integer The index of the first result item to return. 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

This method does not return specific response headers.

Response body

If successful, this method returns a OfficerSearch resource in the body.

Status codes

None.

CURL example

curl -uYOUR_APIKEY_FOLLOWED_BY_A_COLON: https://api.companieshouse.gov.uk/search/officers

Explore this API

q The term being searched for.
items_per_page The number of search results to return per page.
start_index The index of the first result item to return.

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.