--- title: Get scheduled on-call user description: Retrieves the user who is on-call for the specified schedule at a given time. breadcrumbs: Docs > API > Get scheduled on-call user --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get scheduled on-call user {% callout %} This product or feature is not supported for the following sites: us2.ddog-gov.com {% /callout %} ## v2 (deprecated) | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-call | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-call | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-call | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/on-call/schedules/{schedule_id}/on-call | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-call | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-call | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/on-call | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}/on-call | | us2.ddog-gov.com | GET https://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 | Field | Type | Description | | ------------------------ | ------ | ----------------------- | | schedule_id [*required*] | string | The ID of the schedule. | #### Query Strings | Field | 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 {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} An on-call shift with its associated data and relationships. | Parent field | Field | Type | Description | | ------------- | ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | | data | object | Data for an on-call shift. | | data | 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. | | data | id | string | The `ShiftData` `id`. | | data | 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`. | | data | type [*required*] | enum | Indicates that the resource is of type 'shifts'. Allowed enum values: `shifts`. Default: `shifts`. | | | included | [] | The `Shift` `included`. | | included | | object | Represents a user object in the context of a schedule, including their `id`, type, and basic attributes. | | | attributes | object | Provides basic user information for a schedule, including a name and email address. | | attributes | color | string | The user's on-call color, as a hex code (for example, `#FF0000`). Included only when `user.color` is requested in the `include` parameter. | | attributes | email | string | The user's email address. | | attributes | name | string | The user's name. | | attributes | status | enum | The user's status. Allowed enum values: `active`, `deactivated`, `pending`. | | | id [*required*] | string | The unique user identifier. | | | type [*required*] | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "end": "2025-05-07T03:53:01.206662873Z", "start": "2025-05-07T02:53:01.206662814Z" }, "id": "00000000-0000-0000-0000-000000000000", "relationships": { "user": { "data": { "id": "00000000-aba1-0000-0000-000000000000", "type": "users" } } }, "type": "shifts" }, "included": [ { "attributes": { "email": "foo@bar.com", "name": "User 1", "status": "" }, "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}/on-call" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get scheduled on-call user 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.GetScheduleOnCallUser(ctx, ScheduleDataID, *datadogV2.NewGetScheduleOnCallUserOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnCallApi.GetScheduleOnCallUser`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OnCallApi.GetScheduleOnCallUser`:\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 scheduled on-call user 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.Shift; 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 { Shift result = apiInstance.getScheduleOnCallUser(SCHEDULE_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OnCallApi#getScheduleOnCallUser"); 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 scheduled on-call user 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_user( 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 scheduled on-call user 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_user(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 scheduled on-call user returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_on_call::GetScheduleOnCallUserOptionalParams; 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_user( schedule_data_id.clone(), GetScheduleOnCallUserOptionalParams::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 scheduled on-call user 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.OnCallApiGetScheduleOnCallUserRequest = { scheduleId: SCHEDULE_DATA_ID, }; apiInstance .getScheduleOnCallUser(params) .then((data: v2.Shift) => { 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 %}