This section helps you get started with our REST API.

​
Authentication

All requests to the Shiftkeeper API must be authenticated using an x-api-key header with your API key. Go to Settings > API Keys to generate your API key.

​
Content types

The API accepts JSON in the request body and returns JSON in the response body. Make sure to include the content-type: application/json header in your requests.

​
Response codes

The API uses standard HTTP status codes to indicate the success or failure of your request. Generally 2xx HTTP status codes indicate success, 4xx codes indicate client errors and 5xx indicate errors originating from Shiftkeeper servers. Check out the Errors page for a detailed list of errors.

​
Rate limits

Responses include rate limit headers that indicate the number of requests you can make in a given time period.
HeaderDescription
x-ratelimit-limitMaximum number of requests allowed within a time window
x-ratelimit-remainingNumber of requests remaining in the current time window
x-ratelimit-resetTime in seconds until the rate limit window resets
retry-afterTime in seconds you need to wait before making another request
(only present when rate limits are exceeded)
Our API rate limits should comfortably accommodate normal usage. If you’re facing issues with rate limits, please contact us.

​
Examples

Create a schedule

POST /schedules

List my on-call shifts

GET /user/shifts

Create a coverage request

POST /user/coverage_requests