--- title: Get team on-call users description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > On-Call --- {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Get team on-call users{% #get-team-on-call-users %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------ | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/on-call/teams/{team_id}/on-call | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/on-call/teams/{team_id}/on-call | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/on-call/teams/{team_id}/on-call | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/on-call/teams/{team_id}/on-call | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/on-call/teams/{team_id}/on-call | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/on-call/teams/{team_id}/on-call | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/on-call/teams/{team_id}/on-call | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/on-call/teams/{team_id}/on-call | ### Overview Get a team's on-call users at a given time This endpoint requires the `on_call_read` permission. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------- | ------ | ----------- | | team_id [*required*] | string | The team ID | #### Query Strings | Name | Type | Description | | ------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------- | | include | string | Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Root object representing a team's on-call responder configuration. | Parent field | Field | Type | Description | | ------------- | ---------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Defines the main on-call responder object for a team, including relationships and metadata. | | data | id | string | Unique identifier of the on-call responder configuration. | | data | relationships | object | Relationship objects linked to a team's on-call responder configuration, including escalations and responders. | | relationships | escalations | object | Defines the escalation policy steps linked to the team's on-call configuration. | | escalations | data | [object] | Array of escalation step references. | | data | id [*required*] | string | Unique identifier of the escalation step. | | data | type [*required*] | enum | Identifies the resource type for escalation policy steps linked to a team's on-call configuration. Allowed enum values: `escalation_policy_steps` | | relationships | responders | object | Defines the list of users assigned as on-call responders for the team. | | responders | data | [object] | Array of user references associated as responders. | | data | id [*required*] | string | Unique identifier of the responder. | | data | type [*required*] | enum | Identifies the resource type for individual user entities associated with on-call response. Allowed enum values: `users` | | data | type [*required*] | enum | Represents the resource type for a group of users assigned to handle on-call duties within a team. Allowed enum values: `team_oncall_responders` | | | included | [ ] | The `TeamOnCallResponders` `included`. | | included | Option 1 | object | User object returned by the API. | | Option 1 | 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. | | attributes | mfa_enabled | boolean | Whether multi-factor authentication (MFA) is enabled for the user's account. | | 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. | | attributes | verified | boolean | Whether the user's email address has been verified. | | Option 1 | id | string | ID of the user. | | Option 1 | 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` | | 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` | | 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` | | 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` | | Option 1 | type | enum | Users resource type. Allowed enum values: `users` | | included | Option 2 | object | Represents an escalation policy step. | | Option 2 | id | string | Unique identifier of the escalation step. | | Option 2 | relationships | object | Contains the relationships of an escalation object, including its responders. | | relationships | responders | object | Lists the users involved in a specific step of the escalation policy. | | responders | data | [object] | Array of user references assigned as responders for this escalation step. | | data | id [*required*] | string | Unique identifier of the user assigned to the escalation step. | | data | type [*required*] | enum | Represents the resource type for users assigned as responders in an escalation step. Allowed enum values: `users` | | Option 2 | type [*required*] | enum | Represents the resource type for individual steps in an escalation policy used during incident response. Allowed enum values: `escalation_policy_steps` | {% /tab %} {% tab title="Example" %} ```json { "data": { "id": "111ee23r-aaaaa-aaaa-aaww-1234wertsd23", "relationships": { "escalations": { "data": [ { "id": "111ee23r-aaaaa-aaaa-aaww-1234wertsd23", "type": "escalation_policy_steps" } ] }, "responders": { "data": [ { "id": "111ee23r-aaaaa-aaaa-aaww-1234wertsd23", "type": "users" } ] } }, "type": "team_oncall_responders" }, "included": [ { "attributes": { "email": "test@test.com", "name": "Test User", "status": "active" }, "id": "111ee23r-aaaaa-aaaa-aaww-1234wertsd23", "type": "users" }, { "id": "111ee23r-aaaaa-aaaa-aaww-1234wertsd23", "relationships": { "responders": { "data": [ { "id": "111ee23r-aaaaa-aaaa-aaww-1234wertsd23", "type": "users" } ] } }, "type": "escalation_policy_steps" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export team_id="27590dae-47be-4a7d-9abf-8f4e45124020" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/on-call/teams/${team_id}/on-call" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get team on-call users 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 are valid "routing_rules" in the system ROUTING_RULES_DATA_ID = environ["ROUTING_RULES_DATA_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = OnCallApi(api_client) response = api_instance.get_team_on_call_users( include="responders,escalations.responders", team_id=ROUTING_RULES_DATA_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get team on-call users returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::OnCallAPI.new # there are valid "routing_rules" in the system ROUTING_RULES_DATA_ID = ENV["ROUTING_RULES_DATA_ID"] opts = { include: "responders,escalations.responders", } p api_instance.get_team_on_call_users(ROUTING_RULES_DATA_ID, opts) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get team on-call users 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 are valid "routing_rules" in the system RoutingRulesDataID := os.Getenv("ROUTING_RULES_DATA_ID") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewOnCallApi(apiClient) resp, r, err := api.GetTeamOnCallUsers(ctx, RoutingRulesDataID, *datadogV2.NewGetTeamOnCallUsersOptionalParameters().WithInclude("responders,escalations.responders")) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnCallApi.GetTeamOnCallUsers`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OnCallApi.GetTeamOnCallUsers`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get team on-call users 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.api.OnCallApi.GetTeamOnCallUsersOptionalParameters; import com.datadog.api.client.v2.model.TeamOnCallResponders; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); OnCallApi apiInstance = new OnCallApi(defaultClient); // there are valid "routing_rules" in the system String ROUTING_RULES_DATA_ID = System.getenv("ROUTING_RULES_DATA_ID"); try { TeamOnCallResponders result = apiInstance.getTeamOnCallUsers( ROUTING_RULES_DATA_ID, new GetTeamOnCallUsersOptionalParameters() .include("responders,escalations.responders")); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OnCallApi#getTeamOnCallUsers"); 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://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get team on-call users returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_on_call::GetTeamOnCallUsersOptionalParams; use datadog_api_client::datadogV2::api_on_call::OnCallAPI; #[tokio::main] async fn main() { // there are valid "routing_rules" in the system let routing_rules_data_id = std::env::var("ROUTING_RULES_DATA_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = OnCallAPI::with_config(configuration); let resp = api .get_team_on_call_users( routing_rules_data_id.clone(), GetTeamOnCallUsersOptionalParams::default() .include("responders,escalations.responders".to_string()), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get team on-call users returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.OnCallApi(configuration); // there are valid "routing_rules" in the system const ROUTING_RULES_DATA_ID = process.env.ROUTING_RULES_DATA_ID as string; const params: v2.OnCallApiGetTeamOnCallUsersRequest = { include: "responders,escalations.responders", teamId: ROUTING_RULES_DATA_ID, }; apiInstance .getTeamOnCallUsers(params) .then((data: v2.TeamOnCallResponders) => { 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://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}