DAdatadog
On-Call

List On-Call schedule overrides

Retrieve a list of overrides for the specified On-Call schedule within a given time range.

get/api/v2/on-call/schedules/{schedule_id}/overrides

Request

Path parameters

schedule_idstring required
Example:3653d3c6-0c75-11ea-ad28-fb5701eabc7d

The ID of the schedule.

Query parameters

filter[start]string date-time required
Example:2024-01-07T02:53:01Z

Start of the time range to retrieve overrides for, in RFC3339 format (for example, 2025-05-07T02:53:01Z or 2025-05-07T02:53:01+00:00). If you use a time zone offset with +, URL-encode the + as %2B.

filter[end]string date-time required
Example:2024-01-14T02:53:01Z

End of the time range to retrieve overrides for, in RFC3339 format (for example, 2025-05-07T02:53:01Z or 2025-05-07T02:53:01+00:00). If you use a time zone offset with +, URL-encode the + as %2B. The time range cannot exceed 45 days.

includestring

Comma-separated list of related resources to include in the response. Allowed values: user, overridden_user, user.color.

page[size]integer
Example:10

Number of overrides to return per page. The maximum allowed value is 50.

page[number]integer

Specific page number to return.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "end": "2024-01-08T02:53:01.000000000Z",
        "inactive": false,
        "start": "2024-01-07T02:53:01.000000000Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "relationships": {
        "schedule": {
          "data": {
            "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
            "type": "schedules"
          }
        },
        "user": {
          "data": {
            "id": "00000000-aba1-0000-0000-000000000000",
            "type": "users"
          }
        }
      },
      "type": "overrides"
    }
  ],
  "included": [
    {
      "attributes": {
        "email": "jane.doe@example.com",
        "name": "Jane Doe",
        "status": ""
      },
      "id": "00000000-aba1-0000-0000-000000000000",
      "type": "users"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.