Introduction

Paycircle offers a public REST API that serves as a tool for programmatically interacting with functionality and data including company, team member, payroll period, and payments data.

It is designed to facilitate data syncing with third-party applications via GET endpoints and automation via POST endpoints which provide a gateway to Paycircle’s importer tool. Webhooks are also available, providing callbacks when actions are completed, e.g. when payroll is run, to facilitate event-driven workloads.

The API is intended for bureaus. Bureaus can utilise the API to automate and streamline payroll operations and enhance reporting capabilities for all the companies within the bureau.

Authentication

The API uses basic authentication for which credentials can be provided upon request by a Paycircle Account Manager or the Support Team. In other words you will be provided a username and password to provide when calling the API, as explained below.

The credentials are scoped to a bureau and give access to all companies within the bureau.

Add the credentials to each request using an 'Authorisation' header as follows:

• Key: 'Authorisation'

• Value: 'Basic ' + Base64 encoding of your username and password separated by a colon

Getting Started

To get started we recommend making a GET request to 'https://api.paycircle.co.uk/Company/GetCompanyList' with the authorisation header provided as described in the ‘Authentication’ section above.

If the credentials and auth header is correctly configured a list of all companies within the bureau will be returned. You are ready to start building out your integration.

If a list of companies is not returned and/or results in an 4xx HTTP status code, review the credentials and auth header then retry the request.

We also recommend using the 'Try it' button shown in each API endpoint documented in this portal, which allows you to make test requests as well as auto-generate code for a correctly formed request to the endpoint in your chosen programming language.

Restrictions

Restrictions are in place to ensure sensible usage of the API. This includes rate limiting in order to prevent unreasonable numbers of requests per customer per minute.