Overview

WorkEasy Software provides an API that can be used to retrieve most of its resources and reports. The API will continue to evolve as more endpoints and capabilities are added.

We are committed to providing quality developer tools. Send any issues or suggestions to support@workeasysoftware.com.

Interactive Documentation

Common HTTP client tools such as cURL can be used to test the API. We have also provided a convenient method to test directly within our API documentation.

Our documentation is interactive so that you can get started quickly by testing directly within your web browser.

About our API

RESTful

The API uses REST principles to create a standard and familiar interface. If you are new to the concept of REST here is an explanation.

HTTPS

A secure HTTPS connection (SSL) is required in order to make requests to the server. Requests made over HTTP (port 80) will be redirected to HTTPS (port 443).

JSON

The EasyWorkforce API supports only JSON.

Open ID Connect / OAuth based

Our Authentication is based on the industry standard Open ID Connect which utilizes OAuth 2.0.

Read more on the authentication page.

Versioned API

The API endpoints are versioned so that changes can be made to them without breaking existing code that depends on them. We will notify the app’s owner(s) when we release newer versions and obsolete older versions.

There will be a two step process with a grace period to first deprecate and finally obsolete older versions.

Rate Limits

In order to protect against excessive use of the API and ensure availability to all consumers, the API is rate limited.

We have a rate limit of 60 requests per minute per customer. 

When you hit a rate limit you will receive a 429 HTTP status code response. There will also be a Retry-After header provided which will specify the number of seconds until the limit resets. 

Each endpoint has a max limit of 100 records per call. It is possible to change the limit to a lower number if needed and using the “top” and “skip” parameters iterate to get all results.