Pagerduty

pagerduty is an incident management platform designed to alert and empower teams to resolve critical issues efficiently pagerduty is a leading incident management platform that empowers teams to quickly respond to critical issues this connector allows swimlane turbine users to seamlessly integrate with pagerduty, enabling automated incident creation, retrieval, and management by leveraging this integration, users can enhance their incident response capabilities, streamline operations, and ensure timely resolution of incidents, all without writing a single line of code limitations none to date supported versions this pagerduty connector uses the v2 api additional documents documentation pagerduty api reference https //developer pagerduty com/api reference/e65c5833eeb07 pager duty api configuration prerequisites before you can use the pagerduty connector for turbine, you'll need access to the pagerduty api this requires the following an api key authentication using the following parameters url the endpoint url for accessing pagerduty's api api key a unique key provided by pagerduty to authenticate api requests authentication methods url the endpoint url for accessing the pagerduty api api key a token used to authenticate api requests securely, sent as token token=\<apikey> in the authorization header capabilities this pagerduty connector provides the following capabilities create an incident get a log entry get an alert get an incident get a user list alerts for an incident list escalation policies list incidents list log entries list notes for an incident list on calls list services list teams list users create an incident create an incident synchronously without a corresponding event from a monitoring service click here https //developer pagerduty com/api reference/a7d81b0e9200f create an incident get a log entry get details for a specific incident log entry click here https //developer pagerduty com/api reference/3f6cc44614c5f get a log entry get an alert get details for a single alert on a specified incident click here https //developer pagerduty com/api reference/7bdb05c4dfc86 get an alert get an incident get details for a single incident by id click here https //developer pagerduty com/api reference/0a855c5f4f64d get an incident get a user get details about an existing user, optionally including contact methods, notification rules, and teams click here https //developer pagerduty com/api reference/get a user list alerts for an incident list alerts for a specified incident click here https //developer pagerduty com/api reference/072a97d9ea35e list alerts for an incident list escalation policies list all escalation policies, with optional filters by name or team click here https //developer pagerduty com/api reference/72b50ef3c6729 list escalation policies list incidents list existing incidents, with a broad set of filters available for narrowing results click here https //developer pagerduty com/api reference/9d0b4b12e36f9 list incidents list log entries list all incident log entries across the entire account click here https //developer pagerduty com/api reference/db3cbce4ff6fb list log entries list notes for an incident list existing notes for a specified incident click here https //developer pagerduty com/api reference/list incident notes list on calls list the on call entries during a given time range click here https //developer pagerduty com/api reference/a4417a2c4ab27 list on calls list services list existing services, with optional filters by team or name click here https //developer pagerduty com/api reference/e3a2d06f62fa8 list services list teams list teams of your pagerduty account, optionally filtered by name click here https //developer pagerduty com/api reference/1a51b93f3c37a list teams list users list users of your pagerduty account, optionally filtered by name click here https //developer pagerduty com/api reference/0aeacf7d9bf34 list users configurations api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required apikey api key in the authorization header of all requests that are sent to api gateway string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create an incident create an incident in pagerduty synchronously without a corresponding event from a monitoring service requires json body with incident details and headers endpoint url /incidents method post input argument name type required description headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request headers from string required http headers for the request incident object optional unique identifier incident type string required unique identifier incident title string required unique identifier incident service object required unique identifier incident service id string optional unique identifier incident service type string optional unique identifier incident priority object optional unique identifier incident priority id string optional unique identifier incident priority type string optional unique identifier incident urgency string optional unique identifier incident body object optional request body data incident body type string optional request body data incident body details string optional request body data incident incident key string optional unique identifier incident assignments array optional unique identifier incident assignments assignee object optional unique identifier incident assignments assignee type string optional unique identifier incident escalation policy object optional unique identifier incident escalation policy id string optional unique identifier incident escalation policy type string optional unique identifier incident conference bridge object optional unique identifier input example {"json body" {"incident" {"type" "incident","title" "the server is on fire ","service" {"id" "pwixjzs","type" "service reference"},"priority" {"id" "p53zzh5","type" "priority reference"},"urgency" "high","body" {"type" "incident body","details" "a disk is getting full on this machine you should investigate what is causing the disk to fill, and ensure that there is an automated process in place for ensuring data is rotated (eg logs should have logrotate around them) if data is expected to stay on this disk forever, you should start planning to scale up to a larger disk "},"incident key" "baf7cf21b1da41b4b0221008339ff357","assignments" \[{"assignee" {"type" "service reference"}},{"assignee" {"type" "priority reference"}}],"escalation policy" {"id" "pt20ypa","type" "escalation policy reference"},"conference bridge" {"conference number" "+1 415 555 1212","conference url" "https //subdomain pagerduty com"}}},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json","from" "mail id"}} output parameter type description status code number http status code of the response reason string response reason phrase incident object unique identifier incident id string unique identifier incident type string unique identifier incident title string unique identifier incident summary string unique identifier incident self string unique identifier incident html url string url endpoint for the request incident incident number number unique identifier incident created at string unique identifier incident updated at string unique identifier incident status string unique identifier incident incident key string unique identifier incident service object unique identifier incident service id string unique identifier incident service type string unique identifier incident service summary string unique identifier incident service self string unique identifier incident service html url string url endpoint for the request incident priority object unique identifier incident priority id string unique identifier incident priority type string unique identifier incident priority summary string unique identifier incident priority self string unique identifier output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"incident" {"id" "pt4khlk","type" "incident","title" "the server is on fire ","summary" "\[#1234] the server is on fire ","self" "https //api pagerduty com/incidents/pt4khlk","html url" "https //subdomain pagerduty com/incidents/pt4khlk","incident number" 1234,"created at" "2015 10 06t21 30 42z","updated at" "2015 10 06t21 40 23z","status" "triggered","incident key" "baf7cf21b1da41b4b0221008339ff357","service" {},"priority" {},"a list escalation policies retrieve a list of all existing escalation policies in pagerduty requires headers for authentication endpoint url /escalation policies method get input argument name type required description parameters limit number optional parameters for the list escalation policies action parameters offset number optional parameters for the list escalation policies action parameters total boolean optional parameters for the list escalation policies action parameters query string optional parameters for the list escalation policies action parameters include\[] string optional parameters for the list escalation policies action parameters sort by string optional parameters for the list escalation policies action parameters team ids\[] array optional parameters for the list escalation policies action parameters user ids\[] array optional parameters for the list escalation policies action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"query" "","include\[]" "teams","sort by" "name","team ids\[]" \["pq9k7i8"],"user ids\[]" \["pi7dh85"]},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase escalation policies array output field escalation policies escalation policies id string unique identifier escalation policies type string type of the resource escalation policies summary string output field escalation policies summary escalation policies self string output field escalation policies self escalation policies html url string url endpoint for the request escalation policies name string name of the resource escalation policies escalation rules array output field escalation policies escalation rules escalation policies escalation rules id string unique identifier escalation policies escalation rules escalation delay in minutes number output field escalation policies escalation rules escalation delay in minutes escalation policies escalation rules targets array output field escalation policies escalation rules targets escalation policies escalation rules targets id string unique identifier escalation policies escalation rules targets type string type of the resource escalation policies escalation rules targets summary string output field escalation policies escalation rules targets summary escalation policies escalation rules targets self string output field escalation policies escalation rules targets self escalation policies escalation rules targets html url string url endpoint for the request escalation policies services array output field escalation policies services escalation policies services id string unique identifier escalation policies services type string type of the resource escalation policies services summary string output field escalation policies services summary escalation policies services self string output field escalation policies services self escalation policies services html url string url endpoint for the request escalation policies num loops number output field escalation policies num loops output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 39 08 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin get an incident get details for a single incident in pagerduty using the incident id requires parameters, headers, and path parameters endpoint url /incidents/{{id}} method get input argument name type required description path parameters id string required parameters for the get an incident action parameters include\[] string optional parameters for the get an incident action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"id" "pt4khlk","include\[]" "users"},"path parameters" {"id" "pt4khlk"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase incident object unique identifier incident id string unique identifier incident type string unique identifier incident summary string unique identifier incident self string unique identifier incident html url string url endpoint for the request incident incident number number unique identifier incident title string unique identifier incident created at string unique identifier incident updated at string unique identifier incident status string unique identifier incident incident key string unique identifier incident service object unique identifier incident service id string unique identifier incident service type string unique identifier incident service summary string unique identifier incident service self string unique identifier incident service html url string url endpoint for the request incident assignments array unique identifier incident assignments at string unique identifier incident assignments assignee object unique identifier incident assignments assignee id string unique identifier incident assignments assignee type string unique identifier output example {"incident" {"id" "12345678 1234 1234 1234 123456789abc","type" "string","summary" "string","self" "string","html url" "string","incident number" 123,"title" "string","created at" "string","updated at" "string","status" "active","incident key" "string","service" {"id" "12345678 1234 1234 1234 123456789abc","type" "string","summary" "string","self" "string","html url" "string"},"assignments" \[{}],"assigned via" "string","last status change at" "active"}} get an alert get detailed information for a specific alert using incident id and alert id in pagerduty requires oauth scope incidents read endpoint url /incidents/{{id}}/alerts/{{alert id}} method get input argument name type required description path parameters id string required the id of the incident resource path parameters alert id string required the id of the alert to retrieve headers object required http headers for the request headers accept string required versioning header default application/vnd pagerduty+json;version=2 headers content type string required allowed value application/json input example {"path parameters" {"id" "pt4khlx","alert id" "pt4khlk"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase alert object output field alert alert id string unique identifier alert summary string short form server generated label for the object alert type string the type of object allowed value alert alert self string api url for this object alert html url string url where the entity is shown in the web app alert created at string when the alert was first triggered alert status string current alert status (e g triggered or resolved) alert alert key string the alert's de duplication key alert service object output field alert service alert first trigger log entry object output field alert first trigger log entry alert incident object unique identifier alert suppressed boolean whether the alert is suppressed (not created with a parent incident) alert severity string magnitude as reported by the monitoring tool alert integration object output field alert integration alert body object json describing the alert (e g alert body with contexts such as link entries and details fields) output example {"alert" {"id" "12345678 1234 1234 1234 123456789abc","summary" "string","type" "string","self" "string","html url" "string","created at" "string","status" "active","alert key" "string","service" {},"first trigger log entry" {},"incident" {},"suppressed"\ true,"severity" "string","integration" {},"body" {}}} list alerts for an incident list alerts for a specified incident in pagerduty requires oauth scope incidents read and the incident id as a path parameter endpoint url /incidents/{{id}}/alerts method get input argument name type required description path parameters id string required the id of the incident resource parameters limit number optional the number of results per page parameters offset number optional offset to start pagination search results parameters total boolean optional when true, populates the total field in pagination responses default is false for faster responses parameters alert key string optional alert de duplication key parameters include string optional additional details to include allowed values are services, first trigger log entries, incidents parameters sort by string optional field and direction to sort on (created at or resolved at, asc or desc) use field \ direction ; up to two fields, comma separated examples include created at, resolved at, created at \ asc , created at \ desc , resolved at \ asc , resolved at \ desc parameters statuses array optional return only alerts with the given statuses headers object required http headers for the request headers accept string required versioning header default application/vnd pagerduty+json;version=2 headers content type string required allowed value application/json input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"sort by" "created at\ desc"},"path parameters" {"id" "pt4khlk"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase offset number echoes offset pagination property limit number echoes limit pagination property more boolean indicates if there are additional records to return total object total number of records matching the query, or null when not requested alerts array output field alerts alerts id string unique identifier alerts summary string short form server generated label for the object alerts type string the type of object allowed value alert alerts self string api url for this object alerts html url string url where the entity is shown in the web app alerts created at string when the alert was first triggered alerts status string current alert status alerts alert key string the alert's de duplication key alerts service object output field alerts service alerts first trigger log entry object output field alerts first trigger log entry alerts incident object unique identifier alerts suppressed boolean whether the alert is suppressed (not created with a parent incident) alerts severity string magnitude as reported by the monitoring tool alerts integration object output field alerts integration alerts body object json object describing the alert output example {"offset" 123,"limit" 123,"more"\ true,"total" {},"alerts" \[{"id" "12345678 1234 1234 1234 123456789abc","summary" "string","type" "string","self" "string","html url" "string","created at" "string","status" "active","alert key" "string","service" {},"first trigger log entry" {},"incident" {},"suppressed"\ true,"severity" "string","integration" {},"body" {}}]} list incidents retrieve a list of incidents from pagerduty, with optional filters such as status, service, team, user, and time range requires headers for authentication endpoint url /incidents method get input argument name type required description parameters limit number optional parameters for the list incidents action parameters offset number optional parameters for the list incidents action parameters total boolean optional parameters for the list incidents action parameters since string optional parameters for the list incidents action parameters until string optional parameters for the list incidents action parameters date range string optional parameters for the list incidents action parameters incident key string optional parameters for the list incidents action parameters statuses\[] array optional parameters for the list incidents action parameters service ids\[] array optional parameters for the list incidents action parameters team ids\[] array optional parameters for the list incidents action parameters user ids\[] array optional parameters for the list incidents action parameters urgencies\[] array optional parameters for the list incidents action parameters include\[] string optional parameters for the list incidents action parameters sort by string optional parameters for the list incidents action parameters sort direction string optional parameters for the list incidents action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"statuses\[]" \["triggered"],"include\[]" "users"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase incidents array unique identifier incidents id string unique identifier incidents type string unique identifier incidents summary string unique identifier incidents self string unique identifier incidents html url string url endpoint for the request incidents incident number number unique identifier incidents title string unique identifier incidents created at string unique identifier incidents updated at string unique identifier incidents status string unique identifier incidents incident key string unique identifier incidents service object unique identifier incidents service id string unique identifier incidents service type string unique identifier incidents service summary string unique identifier incidents service self string unique identifier incidents service html url string url endpoint for the request incidents assignments array unique identifier incidents assignments file name string unique identifier incidents assignments file string unique identifier incidents assigned via string unique identifier incidents last status change at string unique identifier output example {"status code" 200,"reason" "ok","json body" {"incidents" \[{}],"limit" 1,"offset" 0,"more"\ true}} list log entries retrieve a list of incident log entries across the entire pagerduty account requires oauth scope incidents read and includes parameters and headers for access endpoint url /log entries method get input argument name type required description parameters is overview boolean optional if true, returns a subset of log entries showing only the most important changes to the incident default is false parameters limit number optional the number of results per page parameters offset number optional offset to start pagination search results parameters total boolean optional when true, populates the total field in pagination responses default is false for faster responses parameters include string optional additional models to include allowed values are incidents, services, channels, and teams parameters since string optional start of the date time range to search parameters until string optional end of the date time range to search parameters team ids array optional only results related to these teams are returned the account must have the teams ability to use this parameter parameters time zone string optional time zone in which results are rendered; defaults to the account time zone headers object required http headers for the request headers accept string required versioning header default application/vnd pagerduty+json;version=2 headers content type string required allowed value application/json input example {"parameters" {"limit" 1,"offset" 0,"total"\ false,"is overview"\ false,"include" "incidents","team ids" \["pq9k7i8"],"time zone" "america/los angeles"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase offset number echoes offset pagination property limit number echoes limit pagination property more boolean indicates if there are additional records to return total object total number of records matching the query, or null when not requested log entries array polymorphic list; each item type (e g triggerlogentry, acknowledgelogentry) has a distinct schema log entries acknowledgement timeout number duration for which the acknowledgement lasts, in seconds; may be absent or null on older entries log entries type string entity type name (e g trigger log entry) log entries id string unique identifier log entries summary string short form server generated label for the object log entries self string api url for this object log entries html url string url where the entity is shown in the web app log entries created at string when the log entry was created log entries channel object polymorphic channel (e g api, email, nagios) depending on type log entries agent object user, service, or integration that created or modified the entry log entries note string optional note included with the log entry log entries contexts array contexts such as links to graphs or images log entries service object output field log entries service log entries incident object unique identifier log entries teams array team references unless expanded via include log entries event details object output field log entries event details log entries changeset array string records of custom field updates output example {"offset" 123,"limit" 123,"more"\ true,"total" {},"log entries" \[{"acknowledgement timeout" 123,"type" "string","id" "12345678 1234 1234 1234 123456789abc","summary" "string","self" "string","html url" "string","created at" "string","channel" {},"agent" {},"note" "string","contexts" \[],"service" {},"incident" {},"teams" \[],"event details" {}}]} get a log entry get details for a specific incident log entry in pagerduty, providing additional information for raw event data requires oauth scope incidents read and the log entry id endpoint url /log entries/{{id}} method get input argument name type required description path parameters id string required the id of the log entry resource parameters include string optional additional models to include allowed values are incidents, services, channels, and teams parameters time zone string optional time zone in which results are rendered; defaults to the account time zone headers object required http headers for the request headers accept string required versioning header default application/vnd pagerduty+json;version=2 headers content type string required allowed value application/json input example {"parameters" {"include" "incidents","time zone" "america/los angeles"},"path parameters" {"id" "q02jtsnzwhsekv"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase log entry object polymorphic; schema depends on type (e g trigger log entry) log entry acknowledgement timeout number duration for which the acknowledgement lasts, in seconds; may be absent or null on older entries log entry type string entity type name (e g trigger log entry) log entry id string unique identifier log entry summary string short form server generated label for the object log entry self string api url for this object log entry html url string url where the entity is shown in the web app log entry created at string when the log entry was created log entry channel object polymorphic channel (e g api, email, nagios) depending on type log entry agent object user, service, or integration that created or modified the entry log entry note string optional note included with the log entry log entry contexts array contexts such as links to graphs or images log entry service object output field log entry service log entry incident object unique identifier log entry teams array team references unless expanded via include log entry event details object output field log entry event details log entry changeset array string records of custom field updates output example {"log entry" {"acknowledgement timeout" 123,"type" "string","id" "12345678 1234 1234 1234 123456789abc","summary" "string","self" "string","html url" "string","created at" "string","channel" {},"agent" {},"note" "string","contexts" \[],"service" {},"incident" {},"teams" \[],"event details" {}}} list all of the on calls list the on call entries in pagerduty during a specified time range requires headers for authentication endpoint url /oncalls method get input argument name type required description parameters limit number optional parameters for the list all of the on calls action parameters offset number optional parameters for the list all of the on calls action parameters total boolean optional parameters for the list all of the on calls action parameters earliest boolean optional parameters for the list all of the on calls action parameters escalation policy ids\[] array optional parameters for the list all of the on calls action parameters include\[] string optional parameters for the list all of the on calls action parameters schedule ids\[] array optional parameters for the list all of the on calls action parameters since string optional parameters for the list all of the on calls action parameters time zone string optional parameters for the list all of the on calls action parameters until string optional parameters for the list all of the on calls action parameters user ids\[] array optional parameters for the list all of the on calls action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"earliest"\ false,"escalation policy ids\[]" \["pt20ypa"],"include\[]" "users","schedule ids\[]" \["pi7dh85"],"since" "2015 03 06t15 28 51 05 00","time zone" "asia/hong kong","until" "2015 03 06t15 28 51 05 00","user ids\[]" \["pi7dh85"]},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase oncalls array output field oncalls oncalls escalation policy object output field oncalls escalation policy oncalls escalation policy id string unique identifier oncalls escalation policy type string type of the resource oncalls escalation policy summary string output field oncalls escalation policy summary oncalls escalation policy self string output field oncalls escalation policy self oncalls escalation policy html url string url endpoint for the request oncalls escalation level number output field oncalls escalation level oncalls schedule object output field oncalls schedule oncalls user object output field oncalls user oncalls user id string unique identifier oncalls user type string type of the resource oncalls user summary string output field oncalls user summary oncalls user self string output field oncalls user self oncalls user html url string url endpoint for the request oncalls start object output field oncalls start oncalls end object output field oncalls end limit number output field limit offset number output field offset more boolean output field more total object output field total output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 19 22 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin list services retrieve a list of existing services in pagerduty this action requires headers for authentication endpoint url /services method get input argument name type required description parameters limit number optional parameters for the list services action parameters offset number optional parameters for the list services action parameters total boolean optional parameters for the list services action parameters query string optional parameters for the list services action parameters include\[] string optional parameters for the list services action parameters sort by string optional parameters for the list services action parameters team ids\[] array optional parameters for the list services action parameters time zone string optional parameters for the list services action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"query" "","include\[]" "teams","sort by" "name","team ids\[]" \["pq9k7i8"],"time zone" "asia/hong kong"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase services array output field services services id string unique identifier services name string name of the resource services description string output field services description services created at string output field services created at services updated at string output field services updated at services status string status value services teams array output field services teams services teams id string unique identifier services teams type string type of the resource services teams summary string output field services teams summary services teams self string output field services teams self services teams html url string url endpoint for the request services alert creation string output field services alert creation services addons array output field services addons services addons file name string name of the resource services addons file string output field services addons file services scheduled actions array output field services scheduled actions services scheduled actions file name string name of the resource services scheduled actions file string output field services scheduled actions file services support hours object output field services support hours services last incident timestamp object unique identifier services escalation policy object output field services escalation policy output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 28 11 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin list teams retrieve a list of teams from your pagerduty account, with optional filtering by search query requires headers for authentication endpoint url /teams method get input argument name type required description parameters limit number optional parameters for the list teams action parameters offset number optional parameters for the list teams action parameters query string optional parameters for the list teams action parameters total boolean optional parameters for the list teams action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"query" "","total"\ false},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase teams array output field teams teams id string unique identifier teams name string name of the resource teams description object output field teams description teams type string type of the resource teams summary string output field teams summary teams self string output field teams self teams html url string url endpoint for the request teams default role string output field teams default role teams parent object output field teams parent limit number output field limit offset number output field offset total object output field total more boolean output field more output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 14 02 gmt","content type" "application/json","content length" "603","connection" "keep alive","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin, strict origin when cross origin","acce get a user get details about an existing user in pagerduty using the user's id as a path parameter endpoint url /users/{{id}} method get input argument name type required description path parameters id string required the id of the resource parameters include\[] string optional array of additional models to include in the response allowed values contact methods, notification rules, teams, subdomains headers object required http headers for the request headers accept string required the accept header is used as a versioning header headers content type string required allowed value application/json input example {"parameters" {"include\[]" "contact methods"},"path parameters" {"id" "pxpgf42"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase user object output field user user id string unique identifier user type string the type of object allowed value user user summary string short form server generated label for the object user self string api url for this object user html url string url where the entity is shown in the web app user name string the name of the user user email string the user's email address user time zone string the preferred time zone name for the user user color string the schedule color for the user user role string the user's role in the account user avatar url string the url of the user's avatar user description string the user's bio or description user invitation sent boolean whether a login invitation has been sent to the user user created via sso boolean whether the user account was created via sso user job title string the user's job title user contact methods array the list of contact methods for the user user contact methods id string http method to use user contact methods type string http method to use user contact methods summary string http method to use user contact methods self string http method to use user notification rules array the list of notification rules for the user user notification rules id string unique identifier output example {"user" {"id" "12345678 1234 1234 1234 123456789abc","type" "string","summary" "string","self" "string","html url" "string","name" "example name","email" "user\@example com","time zone" "string","color" "string","role" "string","avatar url" "string","description" "string","invitation sent"\ true,"created via sso"\ true,"job title" "string"}} list users list users of your pagerduty account, optionally filtered by a search query requires headers for authentication endpoint url /users method get input argument name type required description parameters limit number optional parameters for the list users action parameters offset number optional parameters for the list users action parameters total boolean optional parameters for the list users action parameters query string optional parameters for the list users action parameters include\[] string optional parameters for the list users action parameters team ids\[] array optional parameters for the list users action headers object required http headers for the request headers accept string required http headers for the request headers content type string required http headers for the request input example {"parameters" {"limit" 25,"offset" 0,"total"\ false,"query" "","include\[]" "teams","team ids\[]" \["pq9k7i8"]},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase users array output field users users name string name of the resource users email string output field users email users time zone string output field users time zone users color string output field users color users avatar url string url endpoint for the request users billed boolean output field users billed users role string output field users role users description object output field users description users invitation sent boolean output field users invitation sent users job title object output field users job title users teams array output field users teams users teams id string unique identifier users teams type string type of the resource users teams summary string output field users teams summary users teams self string output field users teams self users teams html url string url endpoint for the request users contact methods array http method to use users contact methods id string http method to use users contact methods type string http method to use users contact methods summary string http method to use users contact methods self string http method to use users contact methods html url object url endpoint for the request output example {"status code" 200,"response headers" {"server" "nginx","date" "fri, 10 nov 2023 07 30 38 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","vary" "accept encoding, accept","access control allow origin" " ","x frame options" "sameorigin","x xss protection" "1; mode=block, 1; mode=block","x content type options" "nosniff, nosniff","x download options" "noopen","x permitted cross domain policies" "none","referrer policy" "strict origin when cross origin list notes for an incident list existing notes for the specified incident in pagerduty using the incident id as a path parameter endpoint url /incidents/{{id}}/notes method get input argument name type required description path parameters id string required the id of the resource headers object required http headers for the request headers accept string required the accept header is used as a versioning header headers content type string required allowed value application/json input example {"path parameters" {"id" "pt4khlk"},"headers" {"accept" "application/vnd pagerduty+json;version=2","content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase notes array output field notes notes id string unique identifier of the note notes user object the author of the note notes user id string unique identifier notes user type string the type of the user reference (e g user reference, bot user reference) notes user summary string short form label for the user notes user self string api url for the user notes user html url string url where the user is shown in the web app notes channel object the channel through which the note was submitted notes channel id string unique identifier notes channel type string the type of channel reference notes channel summary string short form label for the channel notes channel self string api url for the channel notes channel html url string url where the channel entity is shown in the web app notes content string the note content notes created at string the time at which the note was created notes updated at string the time at which the note was last updated output example {"notes" \[{"id" "12345678 1234 1234 1234 123456789abc","user" {},"channel" {},"content" "string","created at" "string","updated at" "string"}]} response headers header description example access control allow headers http response header access control allow headers authorization, content type, authorizationoauth, x early access, from access control allow methods http response header access control allow methods get, post, put, delete, options access control allow origin http response header access control allow origin access control expose headers http response header access control expose headers access control max age http response header access control max age 1728000 cache control directives for caching mechanisms max age=0, private, must revalidate connection http response header connection keep alive content encoding http response header content encoding gzip content length the length of the response body in bytes 603 content type the media type of the resource application/json date the date and time at which the message was originated fri, 10 nov 2023 07 14 02 gmt etag an identifier for a specific version of a resource w/"3acefd6ef0085c19b3ad9be4885e37e0" feature policy http response header feature policy accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none' ratelimit limit http response header ratelimit limit 960 ratelimit remaining http response header ratelimit remaining 955 ratelimit reset http response header ratelimit reset 58 referrer policy http response header referrer policy strict origin when cross origin, strict origin when cross origin server information about the software used by the origin server nginx strict transport security http response header strict transport security max age=31536000; includesubdomains transfer encoding http response header transfer encoding chunked vary http response header vary accept x content type options http response header x content type options nosniff, nosniff x download options http response header x download options noopen x frame options http response header x frame options sameorigin x permitted cross domain policies http response header x permitted cross domain policies none x request id a unique identifier for the request ddabf2ac81e3bded5c563178afae54cb x xss protection http response header x xss protection 1; mode=block, 1; mode=block