Get a user's on-call schedule

GET

/api-public/v2/user/{user}/oncall/schedule

Get the on-call schedule for a user for all teams the user is on, including on-call overrides.

This API may be called a maximum of 60 times per minute.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.victorops.com//api-public/v2/user//oncall/schedule' \
--header 'X-VO-Api-Id;' \
--header 'X-VO-Api-Key;'

Response Example

200 - Example 1

{
    "teamSchedules": [
        {
            "schedules": [
                {
                    "overrides": [
                        {
                            "end": "string",
                            "origOnCallUser": {
                                "username": "string"
                            },
                            "overrideOnCallUser": {
                                "username": "string"
                            },
                            "start": "string"
                        }
                    ],
                    "policy": {
                        "name": "string",
                        "slug": "string"
                    },
                    "schedule": [
                        {
                            "onCallType": "user",
                            "onCallUser": {
                                "username": "string"
                            },
                            "overrideOnCallUser": {
                                "username": "string"
                            },
                            "rolls": [
                                {
                                    "end": "string",
                                    "isRoll": true,
                                    "onCallUser": {
                                        "username": "string"
                                    },
                                    "start": "string"
                                }
                            ],
                            "rotationName": "string",
                            "shiftName": "string",
                            "shiftRoll": "string"
                        }
                    ]
                }
            ],
            "team": {
                "name": "string",
                "slug": "string"
            }
        }
    ]
}

Request

Path Params

Query Params

Header Params

Responses

🟢200The on-call schedule for the user

application/json

Body

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2022-09-10 22:14:54

Get a team's on-call schedule

List routing keys with associated teams