Changelog
Partner platform
Added:
- Connect: a company's owner approves your app on a Sparro-hosted page. A connection can be removed by the company at any time.
- Read endpoints for the connected company,
GET /org,GET /shiftsandGET /mileage, with cursor pagination and an opaqueemployee_reffor employees. - Write endpoints
POST /shifts,POST /shifts/hoursandPOST /mileage, behind theshifts:writeandmileage:writescopes, which are for partner apps only. Every write needs an Idempotency-Key. - Webhooks with signed deliveries, retries and a published test vector:
shift.created,mileage.createdandconnection.revoked. - Machine-readable error codes on the write endpoints.
Changed:
- Rate limits are per connected company and depend on your plan. Writes have their own, lower limits.
- A write answers 403
insufficient_scopefor a token without the write scope. Reads still answer 404.
Removed:
- Ledger entries (
GET /ledger-entries) are no longer documented here. Bookkeeping data is not offered to partner apps.
v1 — initial release
The first public version of the API: OAuth2 authorization-code flow with PKCE, and read-only access to invoices, customers, ledger entries, VAT filings and basic company info, gated by scope. Requests are rate-limited per client; see Rate limits.