This is an open BETA version of the software and is intended only for experienced users of EquipCalendar.

Welcome to the EquipCalendar API!

 Getting Started

The EquipCalendar API lets you integrate with other services and build cool stuff on top of EquipCalendar.

Step 1

Get an API key

Use EquipCalendar, get your API key.

Step 2

Read the docs

Learn the conventions and what it can do.

Step 3

Move some data!

Start exchanging data with EquipCalendar.

Conventions

HTTP Methods and URLs

The API uses the following HTTP methods for object manipulation:

GET Used for object retrieval
POST Used for object creation
PUT Used for object update
DELETE Used for object deletion

Formats

JSON

The JSON standard is followed fully in all exhanges with the API. This means that the API can only receive JSON lists or objects. JSON values must be of the correct type:

IDs and Numbers

IDs and numbers in general must be integers, not strings.

Date & Time

Since JSON does not have a type for dates and times, they are exchanged as strings. Dates must be formatted as YYYY-MM-DD and datetimes must be formatted as YYYY-MM-DD HH:MM:SS.

Boolean

Boolean values must be INTEGER values of 0 for false or 1 for true, in any request body or query string parameter. All responses from the REST API will follow this format as well.

Previous Versions

© 2024 EQPD, LLC