Create a schedule
curl --request POST \
--url https://api.shiftkeeper.io/schedules/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"time_zone": "<string>",
"layers": [
{
"name": "<string>",
"rotation_start": "2023-11-07T05:31:56Z",
"concurrent_oncall_users": 2,
"user_references": [
{
"type": "email",
"value": "emma@example.org"
}
],
"shift_length": {
"amount": 2
},
"restriction_intervals": [
{
"from": "<string>",
"to": "<string>"
}
]
}
],
"team_ids": [
"<string>"
],
"description": "<string>"
}
'import requests
url = "https://api.shiftkeeper.io/schedules/"
payload = {
"name": "<string>",
"time_zone": "<string>",
"layers": [
{
"name": "<string>",
"rotation_start": "2023-11-07T05:31:56Z",
"concurrent_oncall_users": 2,
"user_references": [
{
"type": "email",
"value": "emma@example.org"
}
],
"shift_length": { "amount": 2 },
"restriction_intervals": [
{
"from": "<string>",
"to": "<string>"
}
]
}
],
"team_ids": ["<string>"],
"description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
time_zone: '<string>',
layers: [
{
name: '<string>',
rotation_start: '2023-11-07T05:31:56Z',
concurrent_oncall_users: 2,
user_references: [{type: 'email', value: 'emma@example.org'}],
shift_length: {amount: 2},
restriction_intervals: [{from: '<string>', to: '<string>'}]
}
],
team_ids: ['<string>'],
description: '<string>'
})
};
fetch('https://api.shiftkeeper.io/schedules/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.shiftkeeper.io/schedules/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'time_zone' => '<string>',
'layers' => [
[
'name' => '<string>',
'rotation_start' => '2023-11-07T05:31:56Z',
'concurrent_oncall_users' => 2,
'user_references' => [
[
'type' => 'email',
'value' => 'emma@example.org'
]
],
'shift_length' => [
'amount' => 2
],
'restriction_intervals' => [
[
'from' => '<string>',
'to' => '<string>'
]
]
]
],
'team_ids' => [
'<string>'
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.shiftkeeper.io/schedules/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"layers\": [\n {\n \"name\": \"<string>\",\n \"rotation_start\": \"2023-11-07T05:31:56Z\",\n \"concurrent_oncall_users\": 2,\n \"user_references\": [\n {\n \"type\": \"email\",\n \"value\": \"emma@example.org\"\n }\n ],\n \"shift_length\": {\n \"amount\": 2\n },\n \"restriction_intervals\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n ],\n \"team_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.shiftkeeper.io/schedules/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"layers\": [\n {\n \"name\": \"<string>\",\n \"rotation_start\": \"2023-11-07T05:31:56Z\",\n \"concurrent_oncall_users\": 2,\n \"user_references\": [\n {\n \"type\": \"email\",\n \"value\": \"emma@example.org\"\n }\n ],\n \"shift_length\": {\n \"amount\": 2\n },\n \"restriction_intervals\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n ],\n \"team_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shiftkeeper.io/schedules/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"layers\": [\n {\n \"name\": \"<string>\",\n \"rotation_start\": \"2023-11-07T05:31:56Z\",\n \"concurrent_oncall_users\": 2,\n \"user_references\": [\n {\n \"type\": \"email\",\n \"value\": \"emma@example.org\"\n }\n ],\n \"shift_length\": {\n \"amount\": 2\n },\n \"restriction_intervals\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n ],\n \"team_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"schedule": {
"name": "<string>",
"time_zone": "<string>",
"layers": [
{
"name": "<string>",
"rotation_start": "2023-11-07T05:31:56Z",
"concurrent_oncall_users": 2,
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"shift_length": {
"amount": 2
},
"restriction_intervals": [
{
"from": "<string>",
"to": "<string>"
}
]
}
],
"teams": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"current_revision": 1,
"current_revision_valid_from": "2023-11-07T05:31:56Z",
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"description": "<string>",
"current_oncall_shift": {
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"next_oncall_shift": {
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
}
}
}{
"error": {
"code": "duplicate_schedule_name",
"message": "A schedule with this name already exists",
"status": 422,
"docs_url": "https://docs.shiftkeeper.io/api-reference/errors#duplicate-schedule-name"
}
}Schedules
Create a schedule
Create a new schedule.
POST
/
schedules
/
Create a schedule
curl --request POST \
--url https://api.shiftkeeper.io/schedules/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"time_zone": "<string>",
"layers": [
{
"name": "<string>",
"rotation_start": "2023-11-07T05:31:56Z",
"concurrent_oncall_users": 2,
"user_references": [
{
"type": "email",
"value": "emma@example.org"
}
],
"shift_length": {
"amount": 2
},
"restriction_intervals": [
{
"from": "<string>",
"to": "<string>"
}
]
}
],
"team_ids": [
"<string>"
],
"description": "<string>"
}
'import requests
url = "https://api.shiftkeeper.io/schedules/"
payload = {
"name": "<string>",
"time_zone": "<string>",
"layers": [
{
"name": "<string>",
"rotation_start": "2023-11-07T05:31:56Z",
"concurrent_oncall_users": 2,
"user_references": [
{
"type": "email",
"value": "emma@example.org"
}
],
"shift_length": { "amount": 2 },
"restriction_intervals": [
{
"from": "<string>",
"to": "<string>"
}
]
}
],
"team_ids": ["<string>"],
"description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
time_zone: '<string>',
layers: [
{
name: '<string>',
rotation_start: '2023-11-07T05:31:56Z',
concurrent_oncall_users: 2,
user_references: [{type: 'email', value: 'emma@example.org'}],
shift_length: {amount: 2},
restriction_intervals: [{from: '<string>', to: '<string>'}]
}
],
team_ids: ['<string>'],
description: '<string>'
})
};
fetch('https://api.shiftkeeper.io/schedules/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.shiftkeeper.io/schedules/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'time_zone' => '<string>',
'layers' => [
[
'name' => '<string>',
'rotation_start' => '2023-11-07T05:31:56Z',
'concurrent_oncall_users' => 2,
'user_references' => [
[
'type' => 'email',
'value' => 'emma@example.org'
]
],
'shift_length' => [
'amount' => 2
],
'restriction_intervals' => [
[
'from' => '<string>',
'to' => '<string>'
]
]
]
],
'team_ids' => [
'<string>'
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.shiftkeeper.io/schedules/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"layers\": [\n {\n \"name\": \"<string>\",\n \"rotation_start\": \"2023-11-07T05:31:56Z\",\n \"concurrent_oncall_users\": 2,\n \"user_references\": [\n {\n \"type\": \"email\",\n \"value\": \"emma@example.org\"\n }\n ],\n \"shift_length\": {\n \"amount\": 2\n },\n \"restriction_intervals\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n ],\n \"team_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.shiftkeeper.io/schedules/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"layers\": [\n {\n \"name\": \"<string>\",\n \"rotation_start\": \"2023-11-07T05:31:56Z\",\n \"concurrent_oncall_users\": 2,\n \"user_references\": [\n {\n \"type\": \"email\",\n \"value\": \"emma@example.org\"\n }\n ],\n \"shift_length\": {\n \"amount\": 2\n },\n \"restriction_intervals\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n ],\n \"team_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shiftkeeper.io/schedules/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"layers\": [\n {\n \"name\": \"<string>\",\n \"rotation_start\": \"2023-11-07T05:31:56Z\",\n \"concurrent_oncall_users\": 2,\n \"user_references\": [\n {\n \"type\": \"email\",\n \"value\": \"emma@example.org\"\n }\n ],\n \"shift_length\": {\n \"amount\": 2\n },\n \"restriction_intervals\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n ],\n \"team_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"schedule": {
"name": "<string>",
"time_zone": "<string>",
"layers": [
{
"name": "<string>",
"rotation_start": "2023-11-07T05:31:56Z",
"concurrent_oncall_users": 2,
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"shift_length": {
"amount": 2
},
"restriction_intervals": [
{
"from": "<string>",
"to": "<string>"
}
]
}
],
"teams": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"current_revision": 1,
"current_revision_valid_from": "2023-11-07T05:31:56Z",
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"description": "<string>",
"current_oncall_shift": {
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"next_oncall_shift": {
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"time_zone": "<string>",
"slack_id": "<string>"
}
],
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
}
}
}{
"error": {
"code": "duplicate_schedule_name",
"message": "A schedule with this name already exists",
"status": 422,
"docs_url": "https://docs.shiftkeeper.io/api-reference/errors#duplicate-schedule-name"
}
}Authorizations
Enter your API key which starts with 'keeper_'
Body
application/json
The name of the schedule.
Required string length:
1 - 60The time zone of the schedule. Must be a valid IANA time zone. Note that the time zone cannot be changed after the schedule is created.
The layers of the schedule. Currently, schedules can have only one layer.
Required array length:
1 elementShow child attributes
Show child attributes
The teams to link to the schedule.
Maximum array length:
10The description of the schedule.
Maximum string length:
200Response
Default Response
Show child attributes
Show child attributes
Example:
{
"name": "Incident responders",
"description": "Incident responders",
"time_zone": "Europe/Berlin",
"layers": [
{
"name": "Main",
"rotation_start": "2024-01-01T00:00:00Z",
"concurrent_oncall_users": 1,
"users": [
{
"id": "usr_bq7CmsOKLmkMeZkUUu1hy",
"name": "Rick",
"email": "rick@example.org",
"time_zone": "Europe/Paris",
"role": "owner",
"seat": "member",
"slack_id": "U082KENSEQ3"
},
{
"id": "usr_C0GwCFdk0I4pBMRny4qYV",
"name": "Dena",
"email": "dena@example.org",
"role": "standard",
"seat": "member",
"slack_id": "U082GMAFR1T"
},
{
"id": "usr_YlxrjoB1JqUsollScfFYT",
"name": "Lily",
"email": "lily@example.org",
"time_zone": "America/New_York",
"role": "standard",
"seat": "viewer",
"slack_id": "U0529FWNCG2"
}
],
"shift_length": { "amount": 1, "unit": "weeks" },
"restriction_intervals": []
}
],
"current_revision": 1,
"current_revision_valid_from": "2024-12-01T00:00:00Z",
"current_oncall_shift": {
"users": [
{
"id": "usr_bq7CmsOKLmkMeZkUUu1hy",
"name": "Rick",
"email": "rick@example.org",
"time_zone": "Europe/Paris",
"role": "owner",
"seat": "member",
"slack_id": "U082KENSEQ3"
}
],
"start": "2024-01-01T00:00:00Z",
"end": "2024-01-01T01:00:00Z"
},
"next_oncall_shift": {
"users": [
{
"id": "usr_C0GwCFdk0I4pBMRny4qYV",
"name": "Dena",
"email": "dena@example.org",
"role": "standard",
"seat": "member",
"slack_id": "U082GMAFR1T"
}
],
"start": "2024-01-01T01:00:00Z",
"end": "2024-01-01T02:00:00Z"
},
"users": [
{
"id": "usr_bq7CmsOKLmkMeZkUUu1hy",
"name": "Rick",
"email": "rick@example.org",
"time_zone": "Europe/Paris",
"role": "owner",
"seat": "member",
"slack_id": "U082KENSEQ3"
},
{
"id": "usr_C0GwCFdk0I4pBMRny4qYV",
"name": "Dena",
"email": "dena@example.org",
"role": "standard",
"seat": "member",
"slack_id": "U082GMAFR1T"
},
{
"id": "usr_YlxrjoB1JqUsollScfFYT",
"name": "Lily",
"email": "lily@example.org",
"time_zone": "America/New_York",
"role": "standard",
"seat": "viewer",
"slack_id": "U0529FWNCG2"
}
],
"teams": [
{
"id": "tea_VJ4sYEOOXVvJBXqFjRzpm",
"name": "Payments",
"description": "All about payments and billing"
}
]
}
⌘I