--- title: "Get on-call responders for a schedule" method: GET path: "/api/v2/on-call/schedules/{schedule_id}/responders" tags: ["On-Call"] --- # Get on-call responders for a schedule `GET /api/v2/on-call/schedules/{schedule_id}/responders` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/responders` - Auth: one of: - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` - OAuth 2 - Authorization code: `/oauth2/v1/authorize` - Token URL: `/oauth2/v1/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Path parameters - `schedule_id` string, required ## Query parameters - `include` string - `filter[position]` string - `filter[at_ts]` string ## Response `200` OK - ScheduleOnCallResponders: Root object representing a schedule's on-call responders, grouped by position (previous, current, next), for a given point in time. - `data` ScheduleOnCallRespondersData: The main data object representing a schedule's on-call responders lookup, including relationships and metadata. - `attributes` ScheduleOnCallRespondersDataAttributes: Attributes for a schedule's on-call responders lookup. - `scheduled_at` string, date-time: The timestamp the responders were resolved at. - `id` string: Unique identifier of this on-call responders lookup. - `relationships` ScheduleOnCallRespondersDataRelationships: Relationships for a schedule's on-call responders lookup, including the schedule and its responder groups. - `responders` ScheduleOnCallRespondersDataRelationshipsResponders: Defines the list of per-position (previous, current, next) responder groups for the schedule. - `data` ScheduleOnCallRespondersDataRelationshipsRespondersDataItems[]: Array of references to the responder groups included in the response. - `id` string, required: Unique identifier of the responder group. - `type` 'schedule_oncall_responder', required: Identifies the resource type for a responder group linked to a schedule's on-call responders lookup. - `schedule` ScheduleOnCallRespondersDataRelationshipsSchedule: Defines the relationship to the schedule this on-call responders lookup was performed for. - `data` ScheduleOnCallRespondersDataRelationshipsScheduleData: Represents a reference to the schedule this on-call responders lookup was performed for. - `id` string, required: Unique identifier of the schedule. - `type` 'schedules', required: Identifies the resource type for the schedule associated with this on-call responders lookup. - `type` 'schedule_oncall_responders', required: Represents the resource type for a schedule's grouped on-call responders across the previous, current, and next positions. - `included` ScheduleOnCallRespondersIncluded[]: Related resources referenced in the responder groups' relationships, such as shifts, schedules, and users. - union: Represents a union of related resources included in the response, such as responder groups, shifts, schedules, and users. - ScheduleOnCallResponderData: 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` ScheduleOnCallResponderDataAttributes: Attributes for one position's (previous, current, or next) group of on-call responder shifts. - `position` 'previous' | 'current' | 'next': Specifies the position of a schedule target (example `previous`, `current`, or `next`). - `id` string: Unique identifier of this responder group. - `relationships` ScheduleOnCallResponderDataRelationships: Relationships for a single position's (previous, current, or next) responder group. - `shifts` ScheduleOnCallResponderDataRelationshipsShifts: 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. - `data` ScheduleOnCallResponderDataRelationshipsShiftsDataItems[]: Array of references to the shifts included in the response. - … - `type` 'schedule_oncall_responder', required: Represents the resource type for a single position's (previous, current, or next) group of on-call responder shifts. - ShiftData: Data for an on-call shift. - `attributes` ShiftDataAttributes: Attributes for an on-call shift. - `end` string, date-time: The end time of the shift. - `start` string, date-time: The start time of the shift. - `id` string: The `ShiftData` `id`. - `relationships` ShiftDataRelationships: Relationships for an on-call shift. - `user` ShiftDataRelationshipsUser: Defines the relationship between a shift and the user who is working that shift. - `data` ShiftDataRelationshipsUserData, required: Represents a reference to the user assigned to this shift, containing the user's ID and resource type. - … - `type` 'shifts', required: Indicates that the resource is of type `shifts`. - ScheduleData: Represents the primary data object for a schedule, linking attributes and relationships. - `attributes` ScheduleDataAttributes: Provides core properties of a schedule object such as its name and time zone. - `max_responders` integer: 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. - `name` string: A short name for the schedule. - `tags` string[]: A list of tags associated with the schedule. - `time_zone` string: The time zone in which this schedule operates. - `id` string: The schedule's unique identifier. - `relationships` ScheduleDataRelationships: Groups the relationships for a schedule object, referencing layers and teams. - `layers` ScheduleDataRelationshipsLayers: Associates layers with this schedule in a data structure. - `data` ScheduleDataRelationshipsLayersDataItems[]: An array of layer references for this schedule. - … - `teams` DataRelationshipsTeams: Associates teams with this schedule in a data structure. - `data` DataRelationshipsTeamsDataItems[]: An array of team references for this schedule. - … - `type` 'schedules', required: Schedules resource type. - User: User object returned by the API. - `attributes` UserAttributes: Attributes of user object returned by the API. - `created_at` string, date-time: The ISO 8601 timestamp of when the user account was created. - `disabled` boolean: Whether the user account is deactivated. Disabled users cannot log in. - `email` string: The email address of the user, used for login and notifications. - `handle` string: The unique handle (username) of the user, typically matching their email prefix. - `icon` string: URL of the user's profile icon, typically a Gravatar URL derived from the email address. - `last_login_time` string, date-time, nullable: The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in. - `mfa_enabled` boolean: Whether multi-factor authentication (MFA) is enabled for the user's account. - `modified_at` string, date-time: The ISO 8601 timestamp of when the user account was last modified. - `name` string, nullable: The full display name of the user as shown in the Datadog UI. - `service_account` boolean: Whether this is a service account rather than a human user. Service accounts are used for programmatic API access. - `status` string: The current status of the user account (for example, `Active`, `Pending`, or `Disabled`). - `title` string, nullable: The job title of the user (for example, "Senior Engineer" or "Product Manager"). - `uuid` string: The globally unique identifier (UUID) of the user. - `verified` boolean: Whether the user's email address has been verified. - `id` string: ID of the user. - `relationships` UserResponseRelationships: Relationships of the user object returned by the API. - `org` RelationshipToOrganization: Relationship to an organization. - `data` RelationshipToOrganizationData, required: Relationship to organization object. - … - `other_orgs` RelationshipToOrganizations: Relationship to organizations. - `data` RelationshipToOrganizationData[], required: Relationships to organization objects. - … - `other_users` RelationshipToUsers: Relationship to users. - `data` RelationshipToUserData[], required: Relationships to user objects. - … - `roles` RelationshipToRoles: Relationship to roles. - `data` RelationshipToRoleData[]: An array containing type and the unique identifier of a role. - … - `type` 'users': Users resource type. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)