How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PagerDuty Users API

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

PagerDuty Users API is one of 38 APIs that PagerDuty publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and an AsyncAPI specification.

This API exposes 35 operations across 17 paths, and defines 25 schemas. It is described by OpenAPI 3.0.2, at version 2.0.0.

Requests are made against a single base URL, https://api.pagerduty.com.

35 operations 17 paths 25 schemas 7 DELETE16 GET7 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2.0.0
Base URL
https://api.pagerduty.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

PagerDuty Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key). By default, every request must be authenticated.

  • api_key — The API Key with format Token token=

Paths & Operations 35

Across 17 paths, the API surfaces 35 operations — 7 DELETE, 16 GET, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 35

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

GET
/users
PagerDuty List users
listUsers 8 params → 200400401403429
POST
/users
PagerDuty Create a user
createUser 3 params body → 201400401402403429
GET
/users/{id}
PagerDuty Get a user
getUser 4 params → 200400401403404429
DELETE
/users/{id}
PagerDuty Delete a user
deleteUser 3 params → 204401403404429
PUT
/users/{id}
PagerDuty Update a user
updateUser 3 params body → 200400401402403404429
GET
/users/{id}/audit/records
PagerDuty List audit records for a user
listUsersAuditRecords 7 params → 200400401402403404429500
GET
/users/{id}/contact_methods
PagerDuty List a user's contact methods
getUserContactMethods 3 params → 200400401403429
POST
/users/{id}/contact_methods
PagerDuty Create a user contact method
createUserContactMethod 3 params body → 201400401403429
GET
/users/{id}/contact_methods/{contact_method_id}
PagerDuty Get a user's contact method
getUserContactMethod 4 params → 200400401403404429
DELETE
/users/{id}/contact_methods/{contact_method_id}
PagerDuty Delete a user's contact method
deleteUserContactMethod 4 params → 204401403404429
PUT
/users/{id}/contact_methods/{contact_method_id}
PagerDuty Update a user's contact method
updateUserContactMethod 4 params body → 200400401403404429
GET
/users/{id}/license
PagerDuty Get the License allocated to a User
getUserLicense 3 params → 200401403404
GET
/users/{id}/notification_rules
PagerDuty List a user's notification rules
getUserNotificationRules 5 params → 200400401403429
POST
/users/{id}/notification_rules
PagerDuty Create a user notification rule
createUserNotificationRule 3 params body → 201400401402403429
GET
/users/{id}/notification_rules/{notification_rule_id}
PagerDuty Get a user's notification rule
getUserNotificationRule 5 params → 200400401403404429
DELETE
/users/{id}/notification_rules/{notification_rule_id}
PagerDuty Delete a user's notification rule
deleteUserNotificationRule 4 params → 204401403404429
PUT
/users/{id}/notification_rules/{notification_rule_id}
PagerDuty Update a user's notification rule
updateUserNotificationRule 4 params body → 200400401402403404429
GET
/users/{id}/notification_subscriptions
PagerDuty List Notification Subscriptions
getUserNotificationSubscriptions 2 params → 200400401403404429
POST
/users/{id}/notification_subscriptions
PagerDuty Create Notification Subcriptions
createUserNotificationSubscriptions 2 params body → 200400401403422
POST
/users/{id}/notification_subscriptions/unsubscribe
PagerDuty Remove Notification Subscriptions
unsubscribeUserNotificationSubscriptions 2 params body → 200401403404422
GET
/users/{id}/oncall_handoff_notification_rules
PagerDuty List a User's Handoff Notification Rules
getUserHandoffNotificationRules 3 params → 200400401403429
POST
/users/{id}/oncall_handoff_notification_rules
PagerDuty Create a User Handoff Notification Rule
createUserHandoffNotificationRule 3 params body → 201400401402403429
GET
/users/{id}/oncall_handoff_notification_rules/{oncall_handoff_notification_rule_id}
PagerDuty Get a user's handoff notification rule
getUserHandoffNotifiactionRule 4 params → 200400401403404429
DELETE
/users/{id}/oncall_handoff_notification_rules/{oncall_handoff_notification_rule_id}
PagerDuty Delete a User's Handoff Notification rule
deleteUserHandoffNotificationRule 4 params → 204401403404429
PUT
/users/{id}/oncall_handoff_notification_rules/{oncall_handoff_notification_rule_id}
PagerDuty Update a User's Handoff Notification Rule
updateUserHandoffNotification 4 params body → 200400401402403404429
GET
/users/{id}/sessions
PagerDuty List a user's active sessions
getUserSessions 3 params → 200400401403404429
DELETE
/users/{id}/sessions
PagerDuty Delete all user sessions
deleteUserSessions 3 params → 204401403404429
GET
/users/{id}/sessions/{type}/{session_id}
PagerDuty Get a user's session
getUserSession 5 params → 200400401403404429
DELETE
/users/{id}/sessions/{type}/{session_id}
PagerDuty Delete a user's session
deleteUserSession 5 params → 204401403404429
GET
/users/{id}/status_update_notification_rules
PagerDuty List a user's status update notification rules
getUserStatusUpdateNotificationRules 5 params → 200400401403429
POST
/users/{id}/status_update_notification_rules
PagerDuty Create a user status update notification rule
createUserStatusUpdateNotificationRule 4 params body → 201400401402403429
GET
/users/{id}/status_update_notification_rules/{status_update_notification_rule_id}
PagerDuty Get a user's status update notification rule
getUserStatusUpdateNotificationRule 6 params → 200400401403404429
DELETE
/users/{id}/status_update_notification_rules/{status_update_notification_rule_id}
PagerDuty Delete a user's status update notification rule
deleteUserStatusUpdateNotificationRule 5 params → 204401403404429
PUT
/users/{id}/status_update_notification_rules/{status_update_notification_rule_id}
PagerDuty Update a user's status update notification rule
updateUserStatusUpdateNotificationRule 5 params body → 200400401402403404429
GET
/users/me
PagerDuty Get the current user
getCurrentUser 3 params → 200400429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are AuditRecord (9 properties), NotificationSubscriptionWithContext (6 properties), NotificationSubscription (5 properties), UserSession (5 properties). Each schema is shown below with its type and property counts.

UserSession
object
5 properties 5 required
NotificationRule
LicenseWithCounts
NotificationSubscription
object
An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable.
5 properties
PhoneContactMethod
The Phone Contact Method of the User, used for Voice or SMS.
AuditMetadata
object
1 property
TeamReference
StatusUpdateNotificationRule
object
A rule for contacting the user for Incident Status Updates.
1 property 1 required
PushContactMethod
The Push Contact Method of the User.
HandoffNotificationRule
object
A rule for contacting the user for Handoff Notifications.
4 properties 3 required
NotificationSubscriptionWithContext
object
An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable with additional context on status of subscription attempt.
6 properties
ContactMethod
LicenseReference
CursorPagination
object
2 properties 2 required
ContactMethodReference
NotificationRuleReference
User
AuditRecord
object
An Audit Trail record
9 properties 5 required
Reference
AuditRecordResponseSchema
PushContactMethodSound
object
2 properties
EmailContactMethod
The Email Contact Method of the User.
NotificationSubscribable
object
A reference of a subscribable entity.
2 properties
Pagination
object
4 properties
Tag

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pagerduty-users-api-openapi.yml Raw ↑

Other APIs PagerDuty publishes across the network.

PagerDuty Events API
PagerDuty Abilities API
PagerDuty Add-Ons API
PagerDuty Alert Grouping Settings API
PagerDuty Analytics API
PagerDuty Audit API
PagerDuty Automation Actions API
PagerDuty Business Services API
PagerDuty Change Events API
PagerDuty Change Tags API
PagerDuty Custom Fields API
PagerDuty Escalation Policies API
Where this information came from

This is an independent, third-party profile of PagerDuty Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.