Skip to main content
POST
/
api
/
schedule
/
on-calls.list
List on-call schedules
curl --request POST \
  --url https://api.example.com/api/schedule/on-calls.list \
  --header 'Content-Type: application/json' \
  --data '
{
  "resources": [
    "872815618512410358"
  ],
  "date_range": "2019-11-11/2019-12-12",
  "teams": [
    "872815618512410358"
  ]
}
'
[
  {
    "id": "872815618512410358",
    "resource": "872815618512410358",
    "team": "872815618512410358",
    "time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
    "schedule_template": {
      "id": "872815618512410358",
      "name": "<string>",
      "description": "<string>",
      "color": "<string>"
    },
    "remark": "<string>",
    "legacy_id": 123
  }
]

Body

application/json
resources
string<snowflake>[]
required
date_range
string<local-date-interval>
required
Example:

"2019-11-11/2019-12-12"

teams
string<snowflake>[] | null

Response

200 - application/json
id
string<snowflake>
required
Example:

"872815618512410358"

resource
string<snowflake>
required
Example:

"872815618512410358"

team
string<snowflake>
required
Example:

"872815618512410358"

time_range
string<local-date-time-interval>
required
Example:

"2019-11-11T12:34:56/2019-12-12T23:59:59"

schedule_template
object
required
remark
string | null
required
legacy_id
integer
required