Interface OnCallApiListOnCallEscalationPoliciesRequest

Hierarchy

  • OnCallApiListOnCallEscalationPoliciesRequest

Properties

filterQuery?: string

Search query to filter escalation policies. Supports free-text search on the policy name (case-insensitive) and structured filters on team.id and tags. When set, filter[team_id], filter[user_id], and filter[schedule_id] are ignored. Can't be combined with filter[tags] or filter[tags_any].

filterScheduleId?: string

Comma-separated list of schedule IDs. Returns escalation policies with a step targeting any of these schedules.

filterTags?: string

Comma-separated list of key:value tags. Returns escalation policies that have all of these tags.

filterTagsAny?: string

Comma-separated list of key:value tags. Returns escalation policies that have at least one of these tags.

filterTeamId?: string

Comma-separated list of team IDs. Returns escalation policies that belong to any of these teams or have a step targeting any of them.

filterUserId?: string

Comma-separated list of user IDs. Returns escalation policies with a step targeting any of these users.

include?: string

Comma-separated list of included relationships to be returned. Allowed values: teams, steps, steps.targets, steps.targets.schedule, user.color. user.color populates the color attribute of users included through steps.targets.

pageNumber?: number

Specific page number to return.

pageSize?: number

Number of escalation policies to return per page. The maximum allowed value is 50.

Generated using TypeDoc