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

Scoped OAuth requires: services.read

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Query Parameters

query?string

Filters the result, showing only the records whose name matches the query.

limit?integer

The number of results per page.

offset?integer

Offset to start pagination search results.

total?boolean

By 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.

Defaultfalse

team_ids[]?array<string>

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

time_zone?string

Time zone in which results will be rendered. This will default to the account time zone.

Formattzinfo

sort_by?string

Used to specify the field you wish to sort the results on.

Default"name"

Value in

"name"
"name:asc"
"name:desc"

include[]?string

Array of additional details to include.

Value in

"escalation_policies"
"teams"
"integrations"
"auto_pause_notifications_parameters"

name?string

Filters the results, showing only services with the specified name.

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Response Body

`application/json`

curl -X GET "https://example.com/services" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json"

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

List services

Authorization

Query Parameters

Header Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`