Skip to main content

List Services

List existing Services.

A service may represent an application, component, or team you wish to open incidents against.

For more information see the API Concepts Document.

Basic Parameters

ParameterDescription
IncludeArray of additional details to include.
QueryFilters the result, showing only the tags whose labels match the query.
Sort ByUsed to specify the field you wish to sort the results on.
Team IDsAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
Time ZoneTime zone in which dates in the result will be rendered.

Advanced Parameters

ParameterDescription
LimitThe number of results per page.
OffsetOffset to start pagination search results.
TotalBy default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.

Example Output

{
"summary": "Response Example",
"value": {
"limit": 25,
"more": false,
"offset": 0,
"services": [
{
"acknowledgement_timeout": 600,
"alert_creation": "create_alerts_and_incidents",
"alert_grouping_parameters": {
"type": "intelligent"
},
"auto_resolve_timeout": 14400,
"created_at": "2015-11-06T11:12:51-05:00",
"escalation_policy": {
"html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA",
"id": "PT20YPA",
"self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
"summary": "Another Escalation Policy",
"type": "escalation_policy_reference"
},
"html_url": "https://subdomain.pagerduty.com/services/PIJ90N7",
"id": "PIJ90N7",
"incident_urgency_rule": {
"during_support_hours": {
"type": "constant",
"urgency": "high"
},
"outside_support_hours": {
"type": "constant",
"urgency": "low"
},
"type": "use_support_hours"
},
"integrations": [
{
"html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
"id": "PQ12345",
"self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
"summary": "Email Integration",
"type": "generic_email_inbound_integration_reference"
}
],
"name": "My Application Service",
"scheduled_actions": [
{
"at": {
"name": "support_hours_start",
"type": "named_time"
},
"to_urgency": "high",
"type": "urgency_change"
}
],
"self": "https://api.pagerduty.com/services/PIJ90N7",
"status": "active",
"summary": "My Application Service",
"support_hours": {
"days_of_week": [
1,
2,
3,
4,
5
],
"end_time": "17:00:00",
"start_time": "09:00:00",
"time_zone": "America/Lima",
"type": "fixed_time_per_day"
},
"teams": [
{
"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
"id": "PQ9K7I8",
"self": "https://api.pagerduty.com/teams/PQ9K7I8",
"summary": "Engineering",
"type": "team_reference"
}
],
"type": "service"
}
],
"total": null
}
}

Workflow Library Example

List Services with Pagerduty and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop