Corporate reporting API reference
Read access for an employer to its own benefit programme: headcount and utilisation, activation trends, feature adoption, the roster of invited, active and deactivated seats, and the programme's invoices.
Every figure is an aggregate, and any figure drawn from fewer employees than the privacy threshold is suppressed. Nothing here returns the content of an employee's will, vault or estate plan.
The roster takes page_size, a cursor for the next page and updated_since, so an HR system can sync only the seats that changed. Invoices are listed newest first with page_size and cursor.
Authenticate with a corporate API key issued by an owner of your organisation's corporate account, sent as Authorization: Bearer twcorp_…. The key's scopes decide which endpoints it may read: corporate:reporting:read for the figures and invoices, corporate:roster:read for the roster.
- Read headcount
- Sync the roster of invited
- List your programme's invoices, newest first.
5 operations · version 1.0.0
How to authenticate
Corporate API key issued by an owner of your organisation's corporate account. Format: Bearer twcorp_…
Authorization: Bearer twcorp_…
Reporting
Aggregate figures for your organisation's benefit programme: headcount and utilisation, activation trends and feature adoption. Any figure drawn from fewer employees than the privacy threshold is suppressed.
Roster
Every seat your organisation has invited, activated or deactivated, with the work details you supplied. It never includes anything an employee has written in their own plan.
Billing
The invoices issued to your organisation for its programme. Read-only.

