Skip to main content
List endpoints use POST with the filters in the JSON body.
Lists only contain what the user behind the ID token can access: usually all the accounting firm’s customers, or only some of them if the firm restricted the user.See also: Data access

​
Paginated lists

These endpoints are paginated: They accept two body fields: They return: To read all results, increase offset by limit until offset reaches recordsFiltered.

​
Unknown fields

POST /customers, POST /mandates and POST /payroll-providers reject any body field they do not know, with 400 unknownField and the list of offending fields. Check the spelling of your filters when you get this error.

​
Non-paginated lists

These endpoints return every matching item at once, as a plain array: For files, keep responses small by acknowledging files once downloaded: acknowledged files are no longer listed.