Introduction

Introduction

Welcome to the documentation for the Staffology Payroll API, a comprehensive REST JSON API for running Payroll in the UK.

The web application itself uses this API and has no other means of accessing data, so anything that you can do in the application you can also do programmatically via the API.

Documentation

The drop-down above gives you access to the different sections of this documentation.

  • Guides - walk-throughs on how to achieve specific tasks via the API
  • Operations - details of the various API calls available to you
  • Models - the schema and example JSON of the models used throughout the API.
The Operations and Models documentation is built automatically using Swagger.
If you prefer you can access the Swagger JSON file directly or use a more traditional Swagger UI.

Test Accounts & Data

Anyone can create an account with us free of charge.
After which you can create a demo employer that has employees and data already loaded. Learn more here.

Use Cases

If you're interested in getting an idea of some of the real-world uses of our API, take a look at our Plugged-In Platforms page.

Questions?

Email us. You'll get a prompt and knowledgeable response about any aspect of the software or API.

Authentication