Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/greenmartialarts/shift-scheduler-web/llms.txt

Use this file to discover all available pages before exploring further.

All requests to the Scheduler API must include an API key in the Authorization header. The API uses stateless HMAC-signed keys — no session tokens or cookies are involved.

​
API key format

Keys follow a two-part format: 
[user_id].[signature]
For example: 
Authorization: Bearer arnav.sk_7a9b...2f1c
The user_id identifies your account. The signature is an HMAC hash that the API verifies on every request. Both parts are required — passing only a user ID will result in a 401 error.

​
Passing your key

Include the key in the Authorization header of every request: 
Authorization: Bearer YOUR_KEY

curl -X POST https://shift-scheduler-api-3nxm.vercel.app/api/schedule \
     -H "Authorization: Bearer YOUR_KEY" \
     -H "Content-Type: application/json" \
     -d '{ ... }'

​
Requesting an API key

API keys are issued on request. Email the following address with your name and a brief description of your use case: arnav.shah.2k10@gmail.com You will receive your [user_id].[signature] key by email.
Version 2.0+ uses a stateless HMAC authentication strategy. Legacy API keys from v1.0 (Python) are not compatible and will be rejected with a 401 error. Request a new key if you are migrating from v1.0.

​
Error responses

StatusMeaning
401 UnauthorizedThe HMAC signature is invalid, the key is malformed, or the key has been revoked.
If you receive a 401, verify that:
  • You are passing the full [user_id].[signature] key, not just one part.
  • You have not trimmed or modified the signature.
  • Your key has not been revoked (contact arnav.shah.2k10@gmail.com to reissue).

​
Rate limiting

Each API key has a daily quota. To check your current usage and remaining quota, call GET /api/usage. 
curl https://shift-scheduler-api-3nxm.vercel.app/api/usage \
     -H "Authorization: Bearer YOUR_KEY"

Build docs developers (and LLMs) love

Get started for freeTalk to us