--- title: Get on-call responders for a schedule description: Retrieves the on-call responders for the specified schedule, grouped by position (previous, current, next), at a given time. breadcrumbs: ドキュメント > API > Get on-call responders for a schedule --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get on-call responders for a schedule {% callout %} This product or feature is not supported for the following sites: us2.ddog-gov.com {% /callout %} ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/responders | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/responders | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/responders | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/on-call/schedules/{schedule_id}/responders | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/responders | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/responders | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/responders | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}/responders | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}/responders | ### Overview 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. This endpoint requires the `on_call_read` permission. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------ | ------ | ----------------------- | | schedule_id [*required*] | string | The ID of the schedule. | #### Query Strings | Field | Type | Description | | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | include | string | Comma-separated list of included relationships to be returned. Allowed values: `schedule`, `responders`, `responders.shifts`, `responders.shifts.user`. | | filter[position] | string | Comma-separated list of positions to retrieve. Allowed values: `previous`, `current`, `next`. Defaults to `current` if omitted. | | filter[at_ts] | string | 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 {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Root object representing a schedule's on-call responders, grouped by position (previous, current, next), for a given point in time. | Parent field | Field | Type | Description | | -------------------------------- | -------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | The main data object representing a schedule's on-call responders lookup, including relationships and metadata. | | data | attributes | object | Attributes for a schedule's on-call responders lookup. | | attributes | scheduled_at | date-time | The timestamp the responders were resolved at. | | data | id | string | Unique identifier of this on-call responders lookup. | | data | relationships | object | Relationships for a schedule's on-call responders lookup, including the schedule and its responder groups. | | relationships | responders | object | Defines the list of per-position (previous, current, next) responder groups for the schedule. | | responders | data | [object] | Array of references to the responder groups included in the response. | | data | id [*required*] | string | Unique identifier of the responder group. | | data | type [*required*] | enum | Identifies the resource type for a responder group linked to a schedule's on-call responders lookup. Allowed enum values: `schedule_oncall_responder`. Default: `schedule_oncall_responder`. | | relationships | schedule | object | Defines the relationship to the schedule this on-call responders lookup was performed for. | | schedule | data | object | Represents a reference to the schedule this on-call responders lookup was performed for. | | data | id [*required*] | string | Unique identifier of the schedule. | | data | type [*required*] | enum | Identifies the resource type for the schedule associated with this on-call responders lookup. Allowed enum values: `schedules`. Default: `schedules`. | | data | type [*required*] | enum | Represents the resource type for a schedule's grouped on-call responders across the previous, current, and next positions. Allowed enum values: `schedule_oncall_responders`. Default: `schedule_oncall_responders`. | | | included | [] | Related resources referenced in the responder groups' relationships, such as shifts, schedules, and users. | | included | | object | Represents one position's (previous, current, or next) group of on-call responder shifts. Positions with no matching shift are omitted entirely from the response. | | | attributes | object | Attributes for one position's (previous, current, or next) group of on-call responder shifts. | | attributes | position | enum | Specifies the position of a schedule target (example `previous`, `current`, or `next`). Allowed enum values: `previous`, `current`, `next`. | | | id | string | Unique identifier of this responder group. | | | relationships | object | Relationships for a single position's (previous, current, or next) responder group. | | relationships | shifts | object | Defines the list of shifts satisfying this responder group's position. Multiple shifts occur when a schedule has multiple concurrent on-call responders at that position. | | shifts | data | [object] | Array of references to the shifts included in the response. | | data | id [*required*] | string | Unique identifier of the shift. | | data | type [*required*] | enum | Indicates that the related resource is of type `shifts`. Allowed enum values: `shifts`. Default: `shifts`. | | | type [*required*] | enum | Represents the resource type for a single position's (previous, current, or next) group of on-call responder shifts. Allowed enum values: `schedule_oncall_responder`. Default: `schedule_oncall_responder`. | | included | | object | Data for an on-call shift. | | | attributes | object | Attributes for an on-call shift. | | attributes | end | date-time | The end time of the shift. | | attributes | start | date-time | The start time of the shift. | | | id | string | The `ShiftData` `id`. | | | relationships | object | Relationships for an on-call shift. | | relationships | user | object | Defines the relationship between a shift and the user who is working that shift. | | user | data [*required*] | object | Represents a reference to the user assigned to this shift, containing the user's ID and resource type. | | data | id [*required*] | string | Specifies the unique identifier of the user. | | data | type [*required*] | enum | Indicates that the related resource is of type 'users'. Allowed enum values: `users`. Default: `users`. | | | type [*required*] | enum | Indicates that the resource is of type 'shifts'. Allowed enum values: `shifts`. Default: `shifts`. | | included | | object | Represents the primary data object for a schedule, linking attributes and relationships. | | | attributes | object | Provides core properties of a schedule object such as its name and time zone. | | attributes | max_responders | int64 | Maximum number of users who can be on call at the same time. The value is between 1 and the number of layers, and no greater than 10. | | attributes | name | string | A short name for the schedule. | | attributes | tags | [string] | A list of tags associated with the schedule. | | attributes | time_zone | string | The time zone in which this schedule operates. | | | id | string | The schedule's unique identifier. | | | relationships | object | Groups the relationships for a schedule object, referencing layers and teams. | | relationships | layers | object | Associates layers with this schedule in a data structure. | | layers | data | [object] | An array of layer references for this schedule. | | data | id [*required*] | string | The unique identifier of the layer in this relationship. | | data | type [*required*] | enum | Layers resource type. Allowed enum values: `layers`. Default: `layers`. | | relationships | teams | object | Associates teams with this schedule in a data structure. | | teams | data | [object] | An array of team references for this schedule. | | data | id [*required*] | string | The unique identifier of the team in this relationship. | | data | type [*required*] | enum | Teams resource type. Allowed enum values: `teams`. Default: `teams`. | | | type [*required*] | enum | Schedules resource type. Allowed enum values: `schedules`. Default: `schedules`. | | included | | object | User object returned by the API. | | | attributes | object | Attributes of user object returned by the API. | | attributes | created_at | date-time | The ISO 8601 timestamp of when the user account was created. | | attributes | disabled | boolean | Whether the user account is deactivated. Disabled users cannot log in. | | attributes | email | string | The email address of the user, used for login and notifications. | | attributes | handle | string | The unique handle (username) of the user, typically matching their email prefix. | | attributes | icon | string | URL of the user's profile icon, typically a Gravatar URL derived from the email address. | | attributes | last_login_time | date-time | The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in. Read-only. | | attributes | mfa_enabled | boolean | Whether multi-factor authentication (MFA) is enabled for the user's account. Read-only. | | attributes | modified_at | date-time | The ISO 8601 timestamp of when the user account was last modified. | | attributes | name | string | The full display name of the user as shown in the Datadog UI. | | attributes | service_account | boolean | Whether this is a service account rather than a human user. Service accounts are used for programmatic API access. | | attributes | status | string | The current status of the user account (for example, `Active`, `Pending`, or `Disabled`). | | attributes | title | string | The job title of the user (for example, "Senior Engineer" or "Product Manager"). | | attributes | uuid | string | The globally unique identifier (UUID) of the user. Read-only. | | attributes | verified | boolean | Whether the user's email address has been verified. | | | id | string | ID of the user. | | | relationships | object | Relationships of the user object returned by the API. | | relationships | org | object | Relationship to an organization. | | org | data [*required*] | object | Relationship to organization object. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs`. Default: `orgs`. | | relationships | other_orgs | object | Relationship to organizations. | | other_orgs | data [*required*] | [object] | Relationships to organization objects. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs`. Default: `orgs`. | | relationships | other_users | object | Relationship to users. | | other_users | data [*required*] | [object] | Relationships to user objects. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | relationships | roles | object | Relationship to roles. | | roles | data | [object] | An array containing type and the unique identifier of a role. | | data | id | string | The unique identifier of the role. | | data | type | enum | Roles type. Allowed enum values: `roles`. Default: `roles`. | | | type | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | {% /tab %} {% tab label="Example" %} ```json { "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" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="401" %} Unauthorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/responders" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get on-call responders for a schedule returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "schedule" in the system ScheduleDataID := os.Getenv("SCHEDULE_DATA_ID") ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewOnCallApi(apiClient) resp, r, err := api.GetScheduleOnCallResponders(ctx, ScheduleDataID, *datadogV2.NewGetScheduleOnCallRespondersOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnCallApi.GetScheduleOnCallResponders`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OnCallApi.GetScheduleOnCallResponders`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get on-call responders for a schedule returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.OnCallApi; import com.datadog.api.client.v2.model.ScheduleOnCallResponders; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); OnCallApi apiInstance = new OnCallApi(defaultClient); // there is a valid "schedule" in the system String SCHEDULE_DATA_ID = System.getenv("SCHEDULE_DATA_ID"); try { ScheduleOnCallResponders result = apiInstance.getScheduleOnCallResponders(SCHEDULE_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OnCallApi#getScheduleOnCallResponders"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get on-call responders for a schedule returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.on_call_api import OnCallApi # there is a valid "schedule" in the system SCHEDULE_DATA_ID = environ["SCHEDULE_DATA_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = OnCallApi(api_client) response = api_instance.get_schedule_on_call_responders( schedule_id=SCHEDULE_DATA_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get on-call responders for a schedule returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::OnCallAPI.new # there is a valid "schedule" in the system SCHEDULE_DATA_ID = ENV["SCHEDULE_DATA_ID"] p api_instance.get_schedule_on_call_responders(SCHEDULE_DATA_ID) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get on-call responders for a schedule returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_on_call::GetScheduleOnCallRespondersOptionalParams; use datadog_api_client::datadogV2::api_on_call::OnCallAPI; #[tokio::main] async fn main() { // there is a valid "schedule" in the system let schedule_data_id = std::env::var("SCHEDULE_DATA_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = OnCallAPI::with_config(configuration); let resp = api .get_schedule_on_call_responders( schedule_data_id.clone(), GetScheduleOnCallRespondersOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get on-call responders for a schedule returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.OnCallApi(configuration); // there is a valid "schedule" in the system const SCHEDULE_DATA_ID = process.env.SCHEDULE_DATA_ID as string; const params: v2.OnCallApiGetScheduleOnCallRespondersRequest = { scheduleId: SCHEDULE_DATA_ID, }; apiInstance .getScheduleOnCallResponders(params) .then((data: v2.ScheduleOnCallResponders) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}