DAdatadog
On-Call

Get on-call responders for a schedule

Retrieves the on-call responders for the specified schedule, grouped by position (previous, current, next), at a given time. Supports schedules with multiple concurrent on-call responders at a position, by returning a list of shifts per position.

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

Request

Path parameters

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

The ID of the schedule.

Query parameters

includestring

Comma-separated list of included relationships to be returned. Allowed values: schedule, responders, responders.shifts, responders.shifts.user.

filter[position]string
Example:previous,current,next

Comma-separated list of positions to retrieve. Allowed values: previous, current, next. Defaults to current if omitted.

filter[at_ts]string
Example:2025-05-07T02:53:01Z

Retrieves the on-call responders at the given timestamp 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. Defaults to the current time if omitted.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "scheduled_at": "2024-05-07T02:53:01.000000000Z"
    },
    "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d-1715054400",
    "relationships": {
      "responders": {
        "data": [
          {
            "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d-1715054400-current",
            "type": "schedule_oncall_responder"
          }
        ]
      },
      "schedule": {
        "data": {
          "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
          "type": "schedules"
        }
      }
    },
    "type": "schedule_oncall_responders"
  },
  "included": [
    {
      "attributes": {
        "position": "current"
      },
      "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d-1715054400-current",
      "relationships": {
        "shifts": {
          "data": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "type": "shifts"
            }
          ]
        }
      },
      "type": "schedule_oncall_responder"
    },
    {
      "attributes": {
        "end": "2024-05-08T02:53:01.000000000Z",
        "start": "2024-05-07T02:53:01.000000000Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "relationships": {
        "user": {
          "data": {
            "id": "00000000-aba1-0000-0000-000000000000",
            "type": "users"
          }
        }
      },
      "type": "shifts"
    },
    {
      "attributes": {
        "email": "test@test.com",
        "name": "Test User",
        "status": "active"
      },
      "id": "00000000-aba1-0000-0000-000000000000",
      "type": "users"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.