Welcome to the documentation of the Schedule API

Compatibility guidelines

The HTTP API is versioned with a single number, which is currently 1

This number symbolizes the major version number. New features can be added to the API in the same version number if there is no breaking change.

The version number is present in the url, for instance /schedules/api/v1 for the current version.

Documentation, Pricing and Key generation

You can find the complete documentation for our API at Developers Platform.

Create an account to receive your FREE key in under a minute!

Additionally, explore our pricing plans, access support, view detailed documentation, and follow our comprehensive tutorials.

Every endpoints of this API require authentication using an API key.

If you don't have an API Key and you need to use the Schedule API, you need to ask Sinay to have one.

To use the API Key, you must add a header named API_KEY with your API Key as a value.

To test the API using Swagger-ui, you must click on the button Authorize and then fill the apiKey field and click on Authorize.

Swagger-ui will then use the api key automatically in each request.

On every endpoints, you can click on Try it out, you can modify the body and then click on Execute

You will be able to see the response.

Add Consumption endpoints: GET /consumption/current-period and GET /consumption/periods.
Add consumptionPeriod schema.
Deprecate GET /usages endpoint (kept for backward compatibility).