Search company officers
Request
GET https://api.company-information.service.gov.uk/search/officers
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| 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.company-information.service.gov.uk/search/officers
