--- title: List On-Call notification rules for a user description: List the notification rules for a user. The authenticated user must be the target user or have the on_call_admin permission breadcrumbs: ドキュメント > API > List On-Call notification rules for a user --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # List On-Call notification rules for a user {% 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/users/{user_id}/notification-rules | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/on-call/users/{user_id}/notification-rules | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/on-call/users/{user_id}/notification-rules | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/on-call/users/{user_id}/notification-rules | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/on-call/users/{user_id}/notification-rules | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/on-call/users/{user_id}/notification-rules | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/on-call/users/{user_id}/notification-rules | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/on-call/users/{user_id}/notification-rules | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/on-call/users/{user_id}/notification-rules | ### Overview List the notification rules for a user. The authenticated user must be the target user or have the `on_call_admin` permission This endpoint requires the `on_call_read` permission. ### Arguments #### Path Parameters | Field | Type | Description | | -------------------- | ------ | ----------- | | user_id [*required*] | string | The user ID | #### Query Strings | Field | Type | Description | | ------- | ------ | ----------------------------------------------------------------------------------------- | | include | string | Comma-separated list of included relationships to be returned. Allowed values: `channel`. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response type for listing notification rules for a user | Parent field | Field | Type | Description | | ---------------------------- | ----------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | Array of notification rule data objects. | | data | attributes | object | Attributes for an on-call notification rule. | | attributes | category | enum | Specifies the category a notification rule will apply to Allowed enum values: `high_urgency`, `low_urgency`. Default: `high_urgency`. | | attributes | channel_settings | | Configuration for the associated channel, if necessary | | channel_settings | | object | Configuration for using a phone notification channel in a notification rule | | | method [*required*] | enum | Specifies the method in which a phone is used in a notification rule Allowed enum values: `sms`, `voice`. | | | type [*required*] | enum | Indicates that the notification channel is a phone Allowed enum values: `phone`. Default: `phone`. | | attributes | delay_minutes | int64 | The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation | | data | id | string | Unique identifier for the rule | | data | relationships | object | Relationship object for creating a notification rule | | relationships | channel | object | Relationship object for creating a notification rule | | channel | data [*required*] | object | Channel relationship data for creating a notification rule | | data | id | string | ID of the notification channel | | data | type | enum | Indicates that the resource is of type 'notification_channels'. Allowed enum values: `notification_channels`. Default: `notification_channels`. | | data | type [*required*] | enum | Indicates that the resource is of type 'notification_rules'. Allowed enum values: `notification_rules`. Default: `notification_rules`. | | | included | [] | | | included | | object | Data for an on-call notification channel | | | attributes | object | Attributes for an on-call notification channel. | | attributes | active | boolean | Whether the notification channel is currently active. | | attributes | config | | Notification channel configuration | | config | | object | Phone notification channel configuration | | | formatted_number [*required*] | string | The formatted international version of Number (e.g. +33 7 1 23 45 67). | | | number [*required*] | string | The E-164 formatted phone number (e.g. +3371234567) | | | region [*required*] | string | The ISO 3166-1 alpha-2 two-letter country code. | | | sms_subscribed_at | date-time | If present, the date the user subscribed this number to SMS messages | | | type [*required*] | enum | Indicates that the notification channel is a phone Allowed enum values: `phone`. Default: `phone`. | | | verified [*required*] | boolean | Indicates whether this phone has been verified by the user in Datadog On-Call | | config | | object | Email notification channel configuration | | | address [*required*] | string | The e-mail address to be notified | | | formats [*required*] | [string] | Preferred content formats for notifications. | | | type [*required*] | enum | Indicates that the notification channel is an e-mail address Allowed enum values: `email`. Default: `email`. | | config | | object | Push notification channel configuration | | | application_name [*required*] | string | The name of the application used to receive push notifications | | | device_name [*required*] | string | The name of the mobile device being used | | | type [*required*] | enum | Indicates that the notification channel is a mobile device for push notifications Allowed enum values: `push`. Default: `push`. | | | id | string | Unique identifier for the channel | | | type [*required*] | enum | Indicates that the resource is of type 'notification_channels'. Allowed enum values: `notification_channels`. Default: `notification_channels`. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "category": "string", "channel_settings": { "method": "sms", "type": "phone" }, "delay_minutes": "integer" }, "id": "string", "relationships": { "channel": { "data": { "id": "string", "type": "notification_channels" } } }, "type": "notification_rules" } ], "included": [ { "attributes": { "active": false, "config": { "formatted_number": "", "number": "", "region": "", "sms_subscribed_at": "2019-09-19T10:00:00.000Z", "type": "phone", "verified": false } }, "id": "string", "type": "notification_channels" } ] } ``` {% /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 user_id="00000000-0000-0000-0000-000000000000" # 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/users/${user_id}/notification-rules" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // List On-Call notification rules for a 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 "user" in the system UserDataID := os.Getenv("USER_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.ListUserNotificationRules(ctx, UserDataID, *datadogV2.NewListUserNotificationRulesOptionalParameters().WithInclude("channel")) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnCallApi.ListUserNotificationRules`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OnCallApi.ListUserNotificationRules`:\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 // List On-Call notification rules for a 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.api.OnCallApi.ListUserNotificationRulesOptionalParameters; import com.datadog.api.client.v2.model.ListOnCallNotificationRulesResponse; 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 "user" in the system String USER_DATA_ID = System.getenv("USER_DATA_ID"); try { ListOnCallNotificationRulesResponse result = apiInstance.listUserNotificationRules( USER_DATA_ID, new ListUserNotificationRulesOptionalParameters().include("channel")); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OnCallApi#listUserNotificationRules"); 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 """ List On-Call notification rules for a 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 "user" in the system USER_DATA_ID = environ["USER_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.list_user_notification_rules( include="channel", user_id=USER_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 # List On-Call notification rules for a 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 "user" in the system USER_DATA_ID = ENV["USER_DATA_ID"] opts = { include: "channel", } p api_instance.list_user_notification_rules(USER_DATA_ID, opts) ``` #### 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 // List On-Call notification rules for a user returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_on_call::ListUserNotificationRulesOptionalParams; use datadog_api_client::datadogV2::api_on_call::OnCallAPI; #[tokio::main] async fn main() { // there is a valid "user" in the system let user_data_id = std::env::var("USER_DATA_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = OnCallAPI::with_config(configuration); let resp = api .list_user_notification_rules( user_data_id.clone(), ListUserNotificationRulesOptionalParams::default().include("channel".to_string()), ) .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 /** * List On-Call notification rules for a 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 "user" in the system const USER_DATA_ID = process.env.USER_DATA_ID as string; const params: v2.OnCallApiListUserNotificationRulesRequest = { include: "channel", userId: USER_DATA_ID, }; apiInstance .listUserNotificationRules(params) .then((data: v2.ListOnCallNotificationRulesResponse) => { 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 %}