All appointments for a person
Searches the whole Companies House register of officers for the name (the same search as GET /officers/search, cached for six hours), keeps the people whose name holds every word given, in any order (accents, punctuation, case and titles ignored), and reads the appointments of up to 5 of them (as GET /officers/{officer_id}/appointments, cached for up to 3 days). Appointments are grouped by company, current ones first; each position names the officer_id and name it belongs to, and people lists each person with their month and year of birth, so different people who share a name can be told apart. People who have objected cannot be found by name, and appointments withheld at their request are left out. people_matched, people_truncated and people_unavailable say how many people matched, whether more matched than were read, and how many could not be read just now; other_names_found offers up to 5 other names the search found (often Companies House's own spelling) to search again with.
Request
- Base URL: https://api.companystack.co.uk
- URL: https://api.companystack.co.uk/officers/person/{name}/appointments
- Auth: one of:
- HTTP bearer
- API key in header X-Api-Key
Path parameters
Query parameters
Appointments to return, current ones first
Response
Appointments grouped by company: { search_name, total_appointments, active_appointments, resigned_appointments, companies_count, companies: [{ company_number, company_name, company_status, sic_code, positions: [{ officer_id, officer_name, officer_role, appointed_on, resigned_on, active }] }], people: [{ officer_id, name, date_of_birth, total_appointments, active_appointments, truncated }], people_matched, people_truncated, people_unavailable, other_names_found }
Changes
No recorded changes to this operation across all 1 revision of this API.