idpath · integerRequiredCompany ID returned by a company lookup. It is not the registration number.
Retrieve available director and officer appointments for one company.
idpath · integerRequiredCompany ID returned by a company lookup. It is not the registration number.
pagequery · integerOptionalPage to retrieve.
per_pagequery · integerOptionalRecords to return per page. No maximum is specified here in the source reference.
include_provenancequery · booleanOptionalInclude source metadata. Some endpoints also change their response structure.
Illustrative default excerpt. This endpoint uses data, total_pages and total_results.
{
"data": [
{
"id": 123,
"first_name": "Alex",
"last_name": "Example",
"appointed_at": "2020-01-01",
"resigned_at": null,
"work_status": "ACTIVE",
"job_title": "Director"
}
],
"total_pages": 1,
"total_results": 1
}