Skip to main content
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>"
}
'
{
  "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"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.shiftkeeper.io/llms.txt

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

Authorizations

​
x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Body

application/json
​
name
string
required

The name of the schedule.

Required string length: 1 - 60
​
time_zone
string
required

The 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.

​
layers
object[]
required

The layers of the schedule. Currently, schedules can have only one layer.

Required array length: 1 element
​
team_ids
string[]
required

The teams to link to the schedule.

Maximum array length: 10
​
description
string

The description of the schedule.

Maximum string length: 200

Response

Default Response

​
schedule
object
required
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"
    }
  ]
}