Skip to main content

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.

All API responses follow a consistent structure, giving you predictable parsing across every endpoint.

​
Success

{
  "message": {
    "text": "Operation completed successfully",
    "token": "operationCompletedSuccessfully"
  },
  "content": {
    "data": { },
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-dd'T'HH:mm:ss.fffZ"
    }
  }
}
  • message.text — a human-readable summary.
  • message.token — a stable machine-readable key. Branch on this rather than on message.text, which may change wording or be localised.
  • content.data — the resource(s) returned by the endpoint.
  • content.metadata — context such as the date and date-time formats used in data.

​
Errors

Errors use the same envelope. The token identifies the error, and tokenArguments carries any parameters needed to render a message. 
{
  "message": {
    "text": "Operation failed",
    "token": "operationFailed",
    "tokenArguments": [
      {
        "name": "argumentName",
        "value": "argumentValue"
      }
    ]
  }
}
Always key your handling off message.token. It is stable across releases and localisations, whereas message.text is presentation only.

​
HTTP status codes

StatusMeaning
200 / 201Success.
400Validation error — check message.token and tokenArguments.
401Missing or invalid X-Auth-Token — see Authentication.
403Authenticated but not authorised for the resource.
404Resource not found within your organisation.
429Rate limited — back off and retry.
5xxServer error — retry with backoff; if it persists, contact support.