Every service in this reference has its own OpenAPI specification, rendered in the sidebar. For convenience, we also publish a single combined specification that bundles all of them — rewritten to one gateway base URL — so you can import the whole API in one step.Documentation Index
Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
Use this file to discover all available pages before exploring further.
Download
Download the combined OpenAPI bundle
A single
.zip containing the combined spec in both JSON (flowpayroll-openapi.json) and YAML (flowpayroll-openapi.yaml). Use the JSON for Postman and Insomnia./v1/billing/clients, /v2/pension/...) and the single server is set to the gateway:
| Environment | Server |
|---|---|
| Sandbox | https://api.sandbox.flowpayroll.ai |
| Live | https://api.flowpayroll.ai |
Import into Postman
Download and unzip
Download
flowpayroll-openapi.zip and extract flowpayroll-openapi.json.Import
In Postman, click Import, drop in
flowpayroll-openapi.json, and choose OpenAPI 3.0 when prompted. Postman generates a collection covering every endpoint.Set the base URL
Postman creates a
baseUrl variable from the server. Point it at sandbox or live as needed.Add your token
Add an
X-Auth-Token header at the collection level using a token from the token endpoint. Optionally add a User-Id header.Browsing individual services
Prefer one service at a time? Every service is rendered in the API reference sidebar — open the group you need and you’ll get the full request/response schema and a built-in playground for each endpoint:| Service | Path prefix |
|---|---|
| Pay API | /v1 |
| Statutory pay | /v1/statutory-pay |
| Court orders | /v1/court-orders |
| Holiday & leave | /v1/holiday |
| Pensions (v2) | /v2/pension |
| Pensions (v1, legacy) | /v1/pension |
| Recurring line items | /v1/recurring-line-items |
| HMRC DPS | /v1/hmrc-dps |
| HMRC P-forms | /v1 |
| Billing | /v1/billing |
The combined bundle is regenerated from the per-service specs. If an endpoint ever differs between the two, the per-service spec is the source of truth.