More
Versions and changes
The API is versioned in its path: /api/v1. Integrations built on v1 keep working as v1 grows.
What can change within v1
New endpoints, new optional parameters, new columns, new values in meta, new report types, new error messages (error.code stays the same). Build your parser to ignore what it doesn't know.What never changes within v1
No column, parameter or endpoint is renamed or removed; no value changes meaning, unit or format; nothing optional becomes required; defaults stay the same. Such changes would come as a new version (/api/v2).A new version is announced to every workspace with active keys before it ships, and v1 keeps running alongside it during a transition period. Every change, small or large, is listed below.
Changelog
Planning label
Every report gains planning_label, "Client - Activity - S43 - 2026" built from the client, the activity and the ISO week, the same for every activity whatever the planning's own title. It is set on rows that sit inside one week (weekly totals, days, shifts, breaks) and empty on rows spanning weeks.
Three reports at the same time per key
A key builds at most 3 reports or feeds at the same time. A 4th one sent while 3 are still being built gets 429 rate_limited with Retry-After, like the per-minute limit. Pages read after the first page of a read don't count.
Pages from one moment
The pages of one report or feed read (JSON, or CSV with limit) now come from the rows of the first page, kept for 15 minutes: later pages answer quickly and can't shift when a planning changes in between. Reports and feeds gain meta.as_of, when the rows were read. Keep passing next_cursor unchanged; a cursor used after 15 minutes reads fresh rows, as before.
Week numbers, supervisor IDs and plannings on totals
Weekly rows of /reports/agents gain week_number (42). Every report gains supervisor_ids, and totals gain planning_title and planning_id. supervisors and supervisor_ids list the team in force on the row's own day or week (teams are dated); supervisors used to list every team of the requested period.
Feed periods
A feed has a default period (this week, last month, the last 4 weeks, fixed dates…) that a call without a period gets. A call can also write the period in words, at the end of the address (/feeds/{slug}/last-week, /feeds/{slug}/2026-W42) or in period.
Saved feeds
Design a file once in Developers → Feeds (from your own Excel example, a template or scratch) and read it at /api/v1/feeds/{slug}?week=… GET /api/v1/feeds lists them. Nothing existing changed.
Grouping, day columns, filters and sorting
/reports/agents takes group_by=week|month with monday … sunday and day_value on weekly rows. Every report takes filter.<field> (with .not .gt .gte .lt .lte .empty) and sort. meta now also returns group_by, filters and sort. Nothing existing changed.
Version 1
API keys with scopes and activity limits; /me, /activities, /agents, /plannings, /reports and /reports/{type} in JSON or CSV; OpenAPI description.