API Documentation

Build with the Equish API

RESTful API for integrating scheduling into your applications

Quick Start

Authentication

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.equish.app/v1/schedules

All API requests require a Bearer token. Get your API key from Settings → API Keys.

Example: Fetch Schedules

GET/v1/schedules

// Response
{
  "schedules": [
    {
      "id": "sch_123",
      "date": "2025-01-27",
      "status": "published",
      "shifts": [
        {
          "id": "shft_456",
          "employee_id": "emp_789",
          "start_time": "09:00",
          "end_time": "17:00"
        }
      ]
    }
  ],
  "has_more": false
}

Core Endpoints

GET/v1/schedules

List all schedules

POST/v1/schedules

Create a new schedule

GET/v1/shifts

List all shifts

POST/v1/shifts

Create a new shift

GET/v1/employees

List all employees

GET/v1/time-off-requests

List time-off requests

POST/v1/time-off-requests/:id/approve

Approve time-off request

GET/v1/availability

Get employee availability

Official SDKs

Webhooks

Real-time notifications for schedule changes, shift swaps, and more.

Changelog

Stay updated with the latest API changes and new features.

Rate Limits

1000 requests per hour. Contact sales for higher limits.

API Documentation

Build with the Equish API

RESTful API for integrating scheduling into your applications

Quick Start

Authentication

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.equish.app/v1/schedules

All API requests require a Bearer token. Get your API key from Settings → API Keys.

Example: Fetch Schedules

GET/v1/schedules

// Response
{
  "schedules": [
    {
      "id": "sch_123",
      "date": "2025-01-27",
      "status": "published",
      "shifts": [
        {
          "id": "shft_456",
          "employee_id": "emp_789",
          "start_time": "09:00",
          "end_time": "17:00"
        }
      ]
    }
  ],
  "has_more": false
}

Core Endpoints

GET/v1/schedules

List all schedules

POST/v1/schedules

Create a new schedule

GET/v1/shifts

List all shifts

POST/v1/shifts

Create a new shift

GET/v1/employees

List all employees

GET/v1/time-off-requests

List time-off requests

POST/v1/time-off-requests/:id/approve

Approve time-off request

GET/v1/availability

Get employee availability

Official SDKs

JavaScript

View Docs

Python

View Docs

PHP

View Docs

Ruby

View Docs

Webhooks

Real-time notifications for schedule changes, shift swaps, and more.

Changelog

Stay updated with the latest API changes and new features.

Rate Limits

1000 requests per hour. Contact sales for higher limits.