For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/on-call/get-scheduled-on-call-user.md. A documentation index is available at /llms.txt.
Language
Datadog site
CAUTIONThis product is not supported for your selected Datadog site. (US2-FED).

Get scheduled on-call user

GEThttps://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.us3.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.us5.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.datadoghq.eu/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.ap1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.ap2.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.uk1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}/on-callhttps://api.us2.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}/on-call

Overview

Retrieves the user who is on-call for the specified schedule at a given time. This endpoint does not support schedules with multiple concurrent on-call responders at a position. Deprecated. Use Get on-call responders for a schedule instead.

This endpoint requires the on_call_read permission.

Arguments

Path Parameters

Name
Type
Description
schedule_id [required]
string

The ID of the schedule.

Query Strings

Name
Type
Description
include
string

Specifies related resources to include in the response as a comma-separated list. Allowed value: user.

filter[at_ts]
string

Retrieves the on-call user 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

An on-call shift with its associated data and relationships.

Field
Type
Description
data
object

Data for an on-call shift.

included
[<oneOf>]

The Shift included.

Code Example

Get scheduled on-call user
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/on-call" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"