List the company officers
Request
GET https://api.company-information.service.gov.uk/company/{company_number}/officers
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| company_number | string | The company number of the officer list being requested. | |
| items_per_page | integer | The number of officers to return per page. | Optional. |
| register_type | string | The register_type determines which officer type is returned for the registers view. Accepted values are:
|
Optional. |
| register_view | string | Display register specific information. If given register is held at Companies House, registers_view set to true and correct register_type specified, only active officers will be returned. Those will also have full date of birth. Accepted values are:
|
Optional. |
| start_index | integer | The offset into the entire result set that this page starts. | Optional. |
| order_by | string | The field by which to order the result set. Possible values are:
|
Optional.
Negating the order_by will reverse the order. For example, order_by=-surname will give results in descending order of surname.
|
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 officerList 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/company/{company_number}/officers
