@@ -13751,6 +13751,19 @@ components:
1375113751 - retryStrategy
1375213752 - fallbackStepName
1375313753 type: object
13754+ Escalation:
13755+ description: Represents an escalation policy step.
13756+ properties:
13757+ id:
13758+ description: Unique identifier of the escalation step.
13759+ type: string
13760+ relationships:
13761+ $ref: '#/components/schemas/EscalationRelationships'
13762+ type:
13763+ $ref: '#/components/schemas/EscalationType'
13764+ required:
13765+ - type
13766+ type: object
1375413767 EscalationPolicy:
1375513768 description: Represents a complete escalation policy response, including policy
1375613769 data and optionally included related resources.
@@ -14260,6 +14273,46 @@ components:
1426014273 type: string
1426114274 x-enum-varnames:
1426214275 - USERS
14276+ EscalationRelationships:
14277+ description: Contains the relationships of an escalation object, including its
14278+ responders.
14279+ properties:
14280+ responders:
14281+ $ref: '#/components/schemas/EscalationRelationshipsResponders'
14282+ type: object
14283+ EscalationRelationshipsResponders:
14284+ description: Lists the users involved in a specific step of the escalation policy.
14285+ properties:
14286+ data:
14287+ description: Array of user references assigned as responders for this escalation
14288+ step.
14289+ items:
14290+ $ref: '#/components/schemas/EscalationRelationshipsRespondersDataItems'
14291+ type: array
14292+ type: object
14293+ EscalationRelationshipsRespondersDataItems:
14294+ description: Represents a user assigned to an escalation step.
14295+ properties:
14296+ id:
14297+ description: Unique identifier of the user assigned to the escalation step.
14298+ example: ''
14299+ type: string
14300+ type:
14301+ $ref: '#/components/schemas/EscalationRelationshipsRespondersDataItemsType'
14302+ required:
14303+ - type
14304+ - id
14305+ type: object
14306+ EscalationRelationshipsRespondersDataItemsType:
14307+ default: users
14308+ description: Represents the resource type for users assigned as responders in
14309+ an escalation step.
14310+ enum:
14311+ - users
14312+ example: users
14313+ type: string
14314+ x-enum-varnames:
14315+ - USERS
1426314316 EscalationTarget:
1426414317 description: Represents an escalation target, which can be a team, user, or
1426514318 schedule.
@@ -14276,6 +14329,16 @@ components:
1427614329 $ref: '#/components/schemas/EscalationTarget'
1427714330 type: array
1427814331 type: object
14332+ EscalationType:
14333+ default: escalation_policy_steps
14334+ description: Represents the resource type for individual steps in an escalation
14335+ policy used during incident response.
14336+ enum:
14337+ - escalation_policy_steps
14338+ example: escalation_policy_steps
14339+ type: string
14340+ x-enum-varnames:
14341+ - ESCALATION_POLICY_STEPS
1427914342 Event:
1428014343 description: The metadata associated with a request.
1428114344 properties:
@@ -37887,6 +37950,150 @@ components:
3788737950 $ref: '#/components/schemas/TeamLink'
3788837951 type: array
3788937952 type: object
37953+ TeamOnCallResponders:
37954+ description: Root object representing a team's on-call responder configuration.
37955+ example:
37956+ data:
37957+ id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
37958+ relationships:
37959+ escalations:
37960+ data:
37961+ - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
37962+ type: escalation_policy_steps
37963+ responders:
37964+ data:
37965+ - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
37966+ type: users
37967+ type: team_oncall_responders
37968+ included:
37969+ - attributes:
37970+ email: test@test.com
37971+ name: Test User
37972+ status: active
37973+ id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
37974+ type: users
37975+ - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
37976+ relationships:
37977+ responders:
37978+ data:
37979+ - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
37980+ type: users
37981+ type: escalation_policy_steps
37982+ properties:
37983+ data:
37984+ $ref: '#/components/schemas/TeamOnCallRespondersData'
37985+ included:
37986+ description: The `TeamOnCallResponders` `included`.
37987+ items:
37988+ $ref: '#/components/schemas/TeamOnCallRespondersIncluded'
37989+ type: array
37990+ type: object
37991+ TeamOnCallRespondersData:
37992+ description: Defines the main on-call responder object for a team, including
37993+ relationships and metadata.
37994+ properties:
37995+ id:
37996+ description: Unique identifier of the on-call responder configuration.
37997+ type: string
37998+ relationships:
37999+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationships'
38000+ type:
38001+ $ref: '#/components/schemas/TeamOnCallRespondersDataType'
38002+ required:
38003+ - type
38004+ type: object
38005+ TeamOnCallRespondersDataRelationships:
38006+ description: Relationship objects linked to a team's on-call responder configuration,
38007+ including escalations and responders.
38008+ properties:
38009+ escalations:
38010+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations'
38011+ responders:
38012+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders'
38013+ type: object
38014+ TeamOnCallRespondersDataRelationshipsEscalations:
38015+ description: Defines the escalation policy steps linked to the team's on-call
38016+ configuration.
38017+ properties:
38018+ data:
38019+ description: Array of escalation step references.
38020+ items:
38021+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems'
38022+ type: array
38023+ type: object
38024+ TeamOnCallRespondersDataRelationshipsEscalationsDataItems:
38025+ description: Represents a link to a specific escalation policy step associated
38026+ with the on-call team.
38027+ properties:
38028+ id:
38029+ description: Unique identifier of the escalation step.
38030+ example: ''
38031+ type: string
38032+ type:
38033+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType'
38034+ required:
38035+ - type
38036+ - id
38037+ type: object
38038+ TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType:
38039+ default: escalation_policy_steps
38040+ description: Identifies the resource type for escalation policy steps linked
38041+ to a team's on-call configuration.
38042+ enum:
38043+ - escalation_policy_steps
38044+ example: escalation_policy_steps
38045+ type: string
38046+ x-enum-varnames:
38047+ - ESCALATION_POLICY_STEPS
38048+ TeamOnCallRespondersDataRelationshipsResponders:
38049+ description: Defines the list of users assigned as on-call responders for the
38050+ team.
38051+ properties:
38052+ data:
38053+ description: Array of user references associated as responders.
38054+ items:
38055+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems'
38056+ type: array
38057+ type: object
38058+ TeamOnCallRespondersDataRelationshipsRespondersDataItems:
38059+ description: Represents a user responder associated with the on-call team.
38060+ properties:
38061+ id:
38062+ description: Unique identifier of the responder.
38063+ example: ''
38064+ type: string
38065+ type:
38066+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType'
38067+ required:
38068+ - type
38069+ - id
38070+ type: object
38071+ TeamOnCallRespondersDataRelationshipsRespondersDataItemsType:
38072+ default: users
38073+ description: Identifies the resource type for individual user entities associated
38074+ with on-call response.
38075+ enum:
38076+ - users
38077+ example: users
38078+ type: string
38079+ x-enum-varnames:
38080+ - USERS
38081+ TeamOnCallRespondersDataType:
38082+ default: team_oncall_responders
38083+ description: Represents the resource type for a group of users assigned to handle
38084+ on-call duties within a team.
38085+ enum:
38086+ - team_oncall_responders
38087+ example: team_oncall_responders
38088+ type: string
38089+ x-enum-varnames:
38090+ - TEAM_ONCALL_RESPONDERS
38091+ TeamOnCallRespondersIncluded:
38092+ description: Represents an union of related resources included in the response,
38093+ such as users and escalation steps.
38094+ oneOf:
38095+ - $ref: '#/components/schemas/User'
38096+ - $ref: '#/components/schemas/Escalation'
3789038097 TeamPermissionSetting:
3789138098 description: Team permission setting
3789238099 properties:
@@ -52469,6 +52676,48 @@ paths:
5246952676 summary: Get the schedule on-call user
5247052677 tags:
5247152678 - On-Call
52679+ /api/v2/on-call/teams/{team_id}/on-call:
52680+ get:
52681+ description: Get a team's on-call users at a given time
52682+ operationId: GetTeamOnCallUsers
52683+ parameters:
52684+ - description: 'Comma-separated list of included relationships to be returned.
52685+ Allowed values: `responders`, `escalations`, `escalations.responders`.'
52686+ in: query
52687+ name: include
52688+ schema:
52689+ type: string
52690+ - description: The team ID
52691+ in: path
52692+ name: team_id
52693+ required: true
52694+ schema:
52695+ example: 27590dae-47be-4a7d-9abf-8f4e45124020
52696+ type: string
52697+ responses:
52698+ '200':
52699+ content:
52700+ application/json:
52701+ schema:
52702+ $ref: '#/components/schemas/TeamOnCallResponders'
52703+ description: OK
52704+ '400':
52705+ $ref: '#/components/responses/BadRequestResponse'
52706+ '401':
52707+ $ref: '#/components/responses/UnauthorizedResponse'
52708+ '403':
52709+ $ref: '#/components/responses/ForbiddenResponse'
52710+ '404':
52711+ $ref: '#/components/responses/NotFoundResponse'
52712+ '429':
52713+ $ref: '#/components/responses/TooManyRequestsResponse'
52714+ security:
52715+ - apiKeyAuth: []
52716+ appKeyAuth: []
52717+ - AuthZ: []
52718+ summary: Get team on-call users
52719+ tags:
52720+ - On-Call
5247252721 /api/v2/on-call/teams/{team_id}/routing-rules:
5247352722 get:
5247452723 description: Get a team's On-Call routing rules
0 commit comments