Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Schedules

List schedules

Lists all schedules that user can view. It optionally takes two parameters - offset and size.<br> <br> Permissions required: Permission to access Jira Service Management; however, the list contains a schedule if:

  • the user has read-only administrative right.
  • the schedule's assigned team is one of the teams that the user belongs to.
  • the user is added to a rotation of the schedule as a responder.
  • a team is added to a rotation of the schedule as a responder, and the user is a member of this team.
  • an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation.
  • there is an override to the user in the schedule.
get/api/{cloudId}/v1/schedules

Query parameters

querystring

The query keyword to filter schedules by name.

It performs an exact match unless the keyword ends with a wildcard character *, in which case it performs a prefix match. Matching is case-insensitive.

sizeinteger

The limit parameter controls the maximum number of items that may be returned for a single request.

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

expandstring[]

The list of possible expansions in the response. Possible values: rotation.

Response

Returned if the request is successful.

_expandsstring[]

List of all possible expansions.

Example response

{
  "values": [
    {
      "id": "f8f2a4ec-54b2-4513-865b-8cb3b81c9544",
      "name": "Support Schedule",
      "description": "On-call schedule for support team",
      "timezone": "America/New_York",
      "enabled": true,
      "teamId": "cd68207b-c55d-4611-ab25-72fd0c439e9f",
      "rotations": [
        {
          "id": "3ce33f53-69be-4b92-8d34-a1df0efe642e",
          "name": "Daily rotation",
          "startDate": "2023-11-10T05:00:00Z",
          "endDate": "2024-04-28T10:00:00Z",
          "type": "weekly",
          "length": 2,
          "participants": [
            {
              "type": "user",
              "id": "14a994fd-78c6-4236-8b83-d107e5d32d6a"
            },
            {
              "type": "team",
              "id": "2ad4505d-d7a9-4997-8745-c40a3b641573"
            }
          ],
          "timeRestriction": {
            "type": "time-of-day",
            "restriction": {
              "startHour": 10,
              "endHour": 20,
              "startMin": 30
            }
          }
        }
      ]
    }
  ],
  "links": {
    "next": "/v1/schedules?offset=50&size=25"
  },
  "_expands": [
    "rotation"
  ]
}
All 240 operations