Officers

Officer history summary: counts only

The counts and summary sentence of GET /officers/{officer_id}/appointments ("12 appointments, 3 companies in insolvency in the last 5 years") without the appointments themselves.

get/officers/{officer_id}/appointments/summary

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/officers/{officer_id}/appointments/summary
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

officer_idstring required

Response

Counts and summary

officer_idstring required
namestring nullable
is_corporate_officerboolean
total_appointmentsinteger required
active_appointmentsinteger
resigned_appointmentsinteger
companiesinteger

Distinct companies

failed_companiesinteger

Companies that went into insolvency (liquidation, administration, receivership, or dissolved after a Gazette insolvency notice) or were dissolved with their accounts overdue, at any time

recent_insolvenciesinteger

Companies in insolvency in the last lookback_years while this officer was appointed or within 12 months of leaving

recent_strike_offsinteger

Companies dissolved with accounts overdue (consistent with compulsory strike-off) in the last lookback_years, on the same terms

lookback_yearsinteger
summarystring required
truncatedboolean

true when the officer has more appointments than were read (500)

_source'cache' | 'companies_house'
_fetched_atstring
_staleboolean

Present (true) when Companies House was unavailable and an older copy was served

Example response

{
  "summary": "12 appointments, 3 companies in insolvency in the last 5 years"
}

Changes

No recorded changes to this operation across all 1 revision of this API.