API Documentation

Connecting and Working with the Shifton API

The Shifton API gives you access to all key features of the platform — from schedule management to integrations with external HR, payroll, and analytics systems.
By using the API, you can automate processes and connect Shifton with your company’s internal services.


API Documentation

We support two versions of our documentation:


Getting Started

Obtain an API Key

In your company settings on the Shifton platform, generate an API key.
Authorization is done via the header:

Authorization: Bearer {your_api_key}

Make Your First Request

For example, to retrieve a list of employees:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

Example response:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

Integrate the API into Your Workflows

  • Automatically create and modify shifts

  • Manage vacation and sick leave requests

  • Export data to payroll systems

  • Build custom dashboards and reports


Core API Capabilities

  • Employees – add, edit, and manage roles

  • Schedules – create, adjust shifts, plan work

  • Time Off & Absences – manage vacation and sick leave requests

  • Reporting – export time, payroll, and attendance data


Error Codes

Shifton API uses standard HTTP status codes:

  • 200 — Successful request

  • 201 — Object successfully created

  • 400 — Invalid parameters

  • 401 — Authorization error (invalid API key)

  • 403 — Access denied

  • 404 — Resource not found

  • 500 — Server error


Usage Tips

  • Always use the new API version for new integrations

  • Use Postman or curl for testing

  • Respect rate limits to avoid being blocked

  • Update integrations that still rely on the old documentation


Share this post