• Alerts
  • Audit Logs
  • Contacts
  • Custom user roles
  • Escalations
  • Forwarding rules
  • Heartbeats
  • Integrations
  • Integration actions
  • Integration outgoing filters
  • Maintenances
  • Notification rules
  • Notification rule steps
  • Routing rules
  • Schedules
  • Schedule on-calls
  • Schedule overrides
  • Schedule rotations
  • Schedule timelines
  • Syncs
  • Sync actions
  • Sync action groups
Cloud
Jira Service Management ops / Reference / REST API

Schedule on-calls

Postman Collection
OpenAPI

This resource represents schedule on-calls in Jira Service Management. Use it to:

  • list on-call responders on a schedule.
  • list the next on-call responders on a schedule.
  • export on-call responders on a schedule in calendar format.
GET

List on-call respondersExperimental

Lists the on-call responders at a specific time for the schedule with given id in the request.

Permissions required: Permission to access to the schedule:

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

Request

Path parameters

scheduleId

string

Required

Query parameters

flat

boolean

date

string

Responses

Returned if the request is successful.

application/json

oneOf [OnCallParticipants, OnCallUsers]

OnCallParticipants

Details of the on-call participants. Returned only flat=false is sent in the request.

OnCallUsers

User IDs of the on-call participants. Returned only flat=true is sent in the request.

GET/v1/schedules/{scheduleId}/on-calls
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/on-calls' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "onCallParticipants": [ { "id": "bc667897-cb21-496f-a46e-7c05ff0419dd", "type": "team" }, { "id": "5b2b0e011b3a756623f4e25e", "type": "user" }, { "id": "7a24e9d7-7a4f-4f86-a1df-21ca9c3112ac", "type": "escalation", "onCallParticipants": [ { "id": "5b2b0e011b3a756623f4e25e", "type": "user", "forwardedFrom": { "id": "c5646941-3f05-404d-8594-825fa73af99f", "type": "user" } } ] } ] }
GET

List next on-call respondersExperimental

Lists the next on-call responders at a specific time for the schedule with given id in the request.

Permissions required: Permission to access to the schedule:

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

Request

Path parameters

scheduleId

string

Required

Query parameters

flat

boolean

date

string

Responses

Returned if the request is successful.

application/json

oneOf [NextOnCallParticipants, NextOnCallUsers]

NextOnCallParticipants

Details of the next on-call participants. Returned only flat=false is sent in the request.

NextOnCallUsers

User IDs of the next on-call participants. Returned only flat=true is sent in the request.

GET/v1/schedules/{scheduleId}/next-on-calls
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}/next-on-calls' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "nextOnCallParticipants": [ { "id": "bc667897-cb21-496f-a46e-7c05ff0419dd", "type": "team" }, { "id": "5b2b0e011b3a756623f4e25e", "type": "user" }, { "id": "7a24e9d7-7a4f-4f86-a1df-21ca9c3112ac", "type": "escalation", "nextOnCallParticipants": [ { "id": "5b2b0e011b3a756623f4e25e", "type": "user", "forwardedFrom": { "id": "c5646941-3f05-404d-8594-825fa73af99f", "type": "user" } } ] } ] }
GET

Export on-call respondersExperimental

Exports the on-call periods in the calendar (.ics) format for the user with given id in the request.

Permissions required: Permission to export to the user on-calls:

  • the user exports the on-call calendar for themselves.
  • the user exports the on-call calendar for another user, and the requesting user is the admin.
  • the user exports the on-call calendar for another user, and the requesting user is the team admin in one of the teams of the requested user.

Request

Path parameters

userIdentifier

string

Required

Responses

Returned if the request is successful.

text/calendar

object

GET/v1/schedules/on-calls/{userIdentifier}.ics
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/on-calls/{userIdentifier}.ics' \ --user 'email@example.com:<api_token>' \ --header 'Accept: text/calendar'

Rate this page: