> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# pagerduty-operations
> PagerDuty Operations — users, teams, schedules, on-call, and status pages
**Server path:** `/pagerduty-operations` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| [`pagerduty_operations_create_schedule`](#pagerduty_operations_create_schedule) | Create a schedule |
| [`pagerduty_operations_create_schedule_override`](#pagerduty_operations_create_schedule_override) | Create one or more overrides |
| [`pagerduty_operations_create_status_page_post`](#pagerduty_operations_create_status_page_post) | Create a Status Page Post |
| [`pagerduty_operations_create_status_page_post_update`](#pagerduty_operations_create_status_page_post_update) | Create a Status Page Post Update |
| [`pagerduty_operations_create_team`](#pagerduty_operations_create_team) | Create a team |
| [`pagerduty_operations_delete_team`](#pagerduty_operations_delete_team) | Delete a team |
| [`pagerduty_operations_delete_team_user`](#pagerduty_operations_delete_team_user) | Remove a user from a team |
| [`pagerduty_operations_get_current_user`](#pagerduty_operations_get_current_user) | Get the current user |
| [`pagerduty_operations_get_schedule`](#pagerduty_operations_get_schedule) | Get a schedule |
| [`pagerduty_operations_get_status_page_post`](#pagerduty_operations_get_status_page_post) | Get a Status Page Post |
| [`pagerduty_operations_get_team`](#pagerduty_operations_get_team) | Get a team |
| [`pagerduty_operations_get_user`](#pagerduty_operations_get_user) | Get a user |
| [`pagerduty_operations_list_on_calls`](#pagerduty_operations_list_on_calls) | List all of the on-calls |
| [`pagerduty_operations_list_schedule_overrides`](#pagerduty_operations_list_schedule_overrides) | List overrides |
| [`pagerduty_operations_list_schedule_users`](#pagerduty_operations_list_schedule_users) | List users on call. |
| [`pagerduty_operations_list_schedules`](#pagerduty_operations_list_schedules) | List schedules |
| [`pagerduty_operations_list_status_page_impacts`](#pagerduty_operations_list_status_page_impacts) | List Status Page Impacts |
| [`pagerduty_operations_list_status_page_post_updates`](#pagerduty_operations_list_status_page_post_updates) | List Status Page Post Updates |
| [`pagerduty_operations_list_status_page_severities`](#pagerduty_operations_list_status_page_severities) | List Status Page Severities |
| [`pagerduty_operations_list_status_page_statuses`](#pagerduty_operations_list_status_page_statuses) | List Status Page Statuses |
| [`pagerduty_operations_list_status_pages`](#pagerduty_operations_list_status_pages) | List Status Pages |
| [`pagerduty_operations_list_team_users`](#pagerduty_operations_list_team_users) | List members of a team |
| [`pagerduty_operations_list_teams`](#pagerduty_operations_list_teams) | List teams |
| [`pagerduty_operations_list_users`](#pagerduty_operations_list_users) | List users |
| [`pagerduty_operations_update_schedule`](#pagerduty_operations_update_schedule) | Update a schedule |
| [`pagerduty_operations_update_team`](#pagerduty_operations_update_team) | Update a team |
| [`pagerduty_operations_update_team_user`](#pagerduty_operations_update_team_user) | Add a user to a team |
***
## pagerduty\_operations\_create\_schedule
Create a schedule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `overflow` | boolean | No | — | Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. |
| `schedule` | object | Yes | — | The schedule value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"overflow": {
"type": "boolean",
"description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`."
},
"schedule": {
"description": "The schedule value"
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"schedule"
]
}
```
***
## pagerduty\_operations\_create\_schedule\_override
Create one or more overrides
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `overrides` | any\[] | No | — | The overrides value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"overrides": {
"type": "array",
"description": "The overrides value"
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id"
]
}
```
***
## pagerduty\_operations\_create\_status\_page\_post
Create a Status Page Post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `id` | string | Yes | — | The ID of the resource. |
| `post` | object | Yes | — | Request schema for creating/updating a given Status Page Post resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"post": {
"type": "object",
"description": "Request schema for creating/updating a given Status Page Post resource.",
"properties": {
"type": {
"type": "string",
"description": "The type of the object returned by the API - in this case, a Status Page Post.",
"enum": [
"status_page_post"
]
},
"title": {
"type": "string",
"description": "The title given to a Post."
},
"post_type": {
"type": "string",
"description": "The type of the Post.",
"enum": [
"incident",
"maintenance"
]
},
"starts_at": {
"type": "string",
"description": "The date and time the Post intent becomes effective - only for maintenance post type."
},
"ends_at": {
"type": "string",
"description": "The date and time the Post intent is concluded - only for maintenance post type."
},
"updates": {
"type": "array",
"items": {
"type": "object"
},
"description": "Post Updates to be associated with a Post"
},
"status_page": {
"type": "object",
"description": "Status Page"
}
},
"required": [
"type",
"title",
"post_type",
"starts_at",
"ends_at",
"updates",
"status_page"
]
}
},
"required": [
"PCID",
"Accept",
"id",
"post"
]
}
```
***
## pagerduty\_operations\_create\_status\_page\_post\_update
Create a Status Page Post Update
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `id` | string | Yes | — | The ID of the resource. |
| `post_id` | string | Yes | — | The ID of the Status Page Post. |
| `post_update` | object | Yes | — | Attributes for Post Update creation/update |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"post_id": {
"type": "string",
"description": "The ID of the Status Page Post."
},
"post_update": {
"type": "object",
"description": "Attributes for Post Update creation/update",
"properties": {
"self": {
"type": "string",
"description": "The path to which the Post Update resource is accessible."
},
"post": {
"type": "object",
"description": "Status Page Post"
},
"message": {
"type": "string",
"description": "The message of the Post Update."
},
"status": {
"type": "object",
"description": "Status Page Status"
},
"severity": {
"type": "object",
"description": "Status Page Severity"
},
"impacted_services": {
"type": "array",
"items": {
"type": "object"
},
"description": "Impacted services represent the status page services affected by a post update, and its impact."
},
"update_frequency_ms": {
"type": "integer",
"description": "The frequency of the next Post Update in milliseconds."
},
"notify_subscribers": {
"type": "boolean",
"description": "Determines if the subscribers should be notified of the Post Update."
},
"reported_at": {
"type": "string",
"description": "The date and time the Post Update was reported."
},
"type": {
"type": "string",
"description": "The type of the object returned by the API - in this case, a Status Page Post Update."
}
},
"required": [
"type",
"message",
"status",
"severity",
"update_frequency_ms",
"notify_subscribers",
"impacted_services",
"post"
]
}
},
"required": [
"PCID",
"Accept",
"id",
"post_id",
"post_update"
]
}
```
***
## pagerduty\_operations\_create\_team
Create a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `team` | object | Yes | — | The team value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"team": {
"description": "The team value"
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"team"
]
}
```
***
## pagerduty\_operations\_delete\_team
Delete a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `reassignment_team` | string | No | — | Team to reassign unresolved incident to. If an unresolved incident exists on both the reassignment team and the team being deleted, a duplicate will not be made. If not supplied, unresolved incidents will be made account-level. |
| `id` | string | Yes | — | The ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"reassignment_team": {
"type": "string",
"description": "Team to reassign unresolved incident to. If an unresolved incident exists on both the reassignment team and the team being deleted, a duplicate will not be made. If not supplied, unresolved incidents will be made account-level."
},
"id": {
"type": "string",
"description": "The ID of the resource."
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id"
]
}
```
***
## pagerduty\_operations\_delete\_team\_user
Remove a user from a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `user_id` | string | Yes | — | The user ID on the team. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"user_id": {
"type": "string",
"description": "The user ID on the team."
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id",
"user_id"
]
}
```
***
## pagerduty\_operations\_get\_current\_user
Get the current user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `include` | string | No | — | Array of additional Models to include in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"include": {
"type": "string",
"description": "Array of additional Models to include in response.",
"enum": [
"contact_methods",
"notification_rules",
"teams",
"subdomains"
]
}
},
"required": [
"PCID",
"Accept",
"Content-Type"
]
}
```
***
## pagerduty\_operations\_get\_schedule
Get a schedule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `time_zone` | string | No | — | Time zone in which results will be rendered. This will default to the schedule's time zone. |
| `since` | string | No | — | The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include\[] for schedule types, populates the rendered\_schedule\_entries fields in the response. |
| `until` | string | No | — | The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include\[] for schedule types, populates the rendered\_schedule\_entries fields in the response. |
| `overflow` | boolean | No | — | Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. |
| `include_next_oncall_for_user` | string | No | — | Specify an `user_id`, and the schedule list API will return information about this user's next on-call. |
| `id` | string | Yes | — | The ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"time_zone": {
"type": "string",
"description": "Time zone in which results will be rendered. This will default to the schedule's time zone."
},
"since": {
"type": "string",
"description": "The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response."
},
"until": {
"type": "string",
"description": "The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response."
},
"overflow": {
"type": "boolean",
"description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`."
},
"include_next_oncall_for_user": {
"type": "string",
"description": "Specify an `user_id`, and the schedule list API will return information about this user's next on-call."
},
"id": {
"type": "string",
"description": "The ID of the resource."
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id"
]
}
```
***
## pagerduty\_operations\_get\_status\_page\_post
Get a Status Page Post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `id` | string | Yes | — | The ID of the resource. |
| `post_id` | string | Yes | — | The ID of the Status Page Post. |
| `include` | string\[] | No | — | Array of additional Models to include in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"post_id": {
"type": "string",
"description": "The ID of the Status Page Post."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"status_page_post_update"
]
},
"description": "Array of additional Models to include in response."
}
},
"required": [
"PCID",
"Accept",
"id",
"post_id"
]
}
```
***
## pagerduty\_operations\_get\_team
Get a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `include` | string | No | — | Array of additional Models to include in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"include": {
"type": "string",
"description": "Array of additional Models to include in response.",
"enum": [
"privileges"
]
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id"
]
}
```
***
## pagerduty\_operations\_get\_user
Get a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `include` | string | No | — | Array of additional Models to include in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"include": {
"type": "string",
"description": "Array of additional Models to include in response.",
"enum": [
"contact_methods",
"notification_rules",
"teams",
"subdomains"
]
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id"
]
}
```
***
## pagerduty\_operations\_list\_on\_calls
List all of the on-calls
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `time_zone` | string | No | — | Time zone in which results will be rendered. This will default to the account time zone. |
| `limit` | integer | No | — | The number of results per page. |
| `offset` | integer | No | — | Offset to start pagination search results. |
| `total` | boolean | No | — | 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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. |
| `include` | string | No | — | Array of additional details to include. |
| `user_ids` | string\[] | No | — | Filters the results, showing only on-calls for the specified user IDs. |
| `escalation_policy_ids` | string\[] | No | — | Filters the results, showing only on-calls for the specified escalation policy IDs. |
| `schedule_ids` | string\[] | No | — | Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets. |
| `since` | string | No | — | The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future. |
| `until` | string | No | — | The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time. |
| `earliest` | boolean | No | — | This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"time_zone": {
"type": "string",
"description": "Time zone in which results will be rendered. This will default to the account time zone."
},
"limit": {
"type": "integer",
"description": "The number of results per page."
},
"offset": {
"type": "integer",
"description": "Offset to start pagination search results."
},
"total": {
"type": "boolean",
"description": "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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information."
},
"include": {
"type": "string",
"description": "Array of additional details to include.",
"enum": [
"escalation_policies",
"users",
"schedules"
]
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters the results, showing only on-calls for the specified user IDs."
},
"escalation_policy_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters the results, showing only on-calls for the specified escalation policy IDs."
},
"schedule_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters the results, showing only on-calls for the specified schedule IDs. If `null` is provided in the array, it includes permanent on-calls due to direct user escalation targets."
},
"since": {
"type": "string",
"description": "The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future."
},
"until": {
"type": "string",
"description": "The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time."
},
"earliest": {
"type": "boolean",
"description": "This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the \"next\" on-calls are for a given set of filters."
}
},
"required": [
"PCID",
"Accept",
"Content-Type"
]
}
```
***
## pagerduty\_operations\_list\_schedule\_overrides
List overrides
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `since` | string | Yes | — | The start of the date range over which you want to search. |
| `until` | string | Yes | — | The end of the date range over which you want to search. |
| `editable` | boolean | No | — | When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable. |
| `overflow` | boolean | No | — | Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"since": {
"type": "string",
"description": "The start of the date range over which you want to search."
},
"until": {
"type": "string",
"description": "The end of the date range over which you want to search."
},
"editable": {
"type": "boolean",
"description": "When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable."
},
"overflow": {
"type": "boolean",
"description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false."
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id",
"since",
"until"
]
}
```
***
## pagerduty\_operations\_list\_schedule\_users
List users on call.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `since` | string | No | — | The start of the date range over which you want to search. |
| `until` | string | No | — | The end of the date range over which you want to search. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"since": {
"type": "string",
"description": "The start of the date range over which you want to search."
},
"until": {
"type": "string",
"description": "The end of the date range over which you want to search."
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id"
]
}
```
***
## pagerduty\_operations\_list\_schedules
List schedules
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `limit` | integer | No | — | The number of results per page. |
| `offset` | integer | No | — | Offset to start pagination search results. |
| `total` | boolean | No | — | 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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. |
| `query` | string | No | — | Filters the result, showing only the records whose name matches the query. |
| `include` | string | No | — | Array of additional details to include. |
| `time_zone` | string | No | — | Time zone in which results will be rendered. This will default to the current user's time zone and then the account's time zone. |
| `include_next_oncall_for_user` | string | No | — | Specify an `user_id`, and the schedule list API will return information about this user's next on-call. |
| `since` | string | No | — | The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include\[] for schedule types, populates the rendered\_schedule\_entries fields in the response. |
| `until` | string | No | — | The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include\[] for schedule types, populates the rendered\_schedule\_entries fields in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"limit": {
"type": "integer",
"description": "The number of results per page."
},
"offset": {
"type": "integer",
"description": "Offset to start pagination search results."
},
"total": {
"type": "boolean",
"description": "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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information."
},
"query": {
"type": "string",
"description": "Filters the result, showing only the records whose name matches the query."
},
"include": {
"type": "string",
"description": "Array of additional details to include.",
"enum": [
"schedule_layers",
"overrides_subschedule",
"final_schedule"
]
},
"time_zone": {
"type": "string",
"description": "Time zone in which results will be rendered. This will default to the current user's time zone and then the account's time zone."
},
"include_next_oncall_for_user": {
"type": "string",
"description": "Specify an `user_id`, and the schedule list API will return information about this user's next on-call."
},
"since": {
"type": "string",
"description": "The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response."
},
"until": {
"type": "string",
"description": "The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response."
}
},
"required": [
"PCID",
"Accept",
"Content-Type"
]
}
```
***
## pagerduty\_operations\_list\_status\_page\_impacts
List Status Page Impacts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `id` | string | Yes | — | The ID of the resource. |
| `post_type` | string | No | — | Filter by Post type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"post_type": {
"type": "string",
"description": "Filter by Post type.",
"enum": [
"incident",
"maintenance"
]
}
},
"required": [
"PCID",
"Accept",
"id"
]
}
```
***
## pagerduty\_operations\_list\_status\_page\_post\_updates
List Status Page Post Updates
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `id` | string | Yes | — | The ID of the resource. |
| `post_id` | string | Yes | — | The ID of the Status Page Post. |
| `reviewed_status` | string | No | — | Filter by the reviewed status of the Post Update to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"post_id": {
"type": "string",
"description": "The ID of the Status Page Post."
},
"reviewed_status": {
"type": "string",
"description": "Filter by the reviewed status of the Post Update to retrieve.",
"enum": [
"approved",
"not_reviewed"
]
}
},
"required": [
"PCID",
"Accept",
"id",
"post_id"
]
}
```
***
## pagerduty\_operations\_list\_status\_page\_severities
List Status Page Severities
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `id` | string | Yes | — | The ID of the resource. |
| `post_type` | string | No | — | Filter by Post type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"post_type": {
"type": "string",
"description": "Filter by Post type.",
"enum": [
"incident",
"maintenance"
]
}
},
"required": [
"PCID",
"Accept",
"id"
]
}
```
***
## pagerduty\_operations\_list\_status\_page\_statuses
List Status Page Statuses
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `id` | string | Yes | — | The ID of the resource. |
| `post_type` | string | No | — | Filter by Post type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"post_type": {
"type": "string",
"description": "Filter by Post type.",
"enum": [
"incident",
"maintenance"
]
}
},
"required": [
"PCID",
"Accept",
"id"
]
}
```
***
## pagerduty\_operations\_list\_status\_pages
List Status Pages
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `status_page_type` | string | No | — | The type of the Status Page. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"status_page_type": {
"type": "string",
"description": "The type of the Status Page.",
"enum": [
"public",
"private"
]
}
},
"required": [
"PCID",
"Accept"
]
}
```
***
## pagerduty\_operations\_list\_team\_users
List members of a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `limit` | integer | No | — | The number of results per page. |
| `offset` | integer | No | — | Offset to start pagination search results. |
| `total` | boolean | No | — | 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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. |
| `id` | string | Yes | — | The ID of the resource. |
| `include` | string | No | — | Array of additional Models to include in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"limit": {
"type": "integer",
"description": "The number of results per page."
},
"offset": {
"type": "integer",
"description": "Offset to start pagination search results."
},
"total": {
"type": "boolean",
"description": "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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information."
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"include": {
"type": "string",
"description": "Array of additional Models to include in response.",
"enum": [
"users"
]
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id"
]
}
```
***
## pagerduty\_operations\_list\_teams
List teams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `limit` | integer | No | — | The number of results per page. |
| `offset` | integer | No | — | Offset to start pagination search results. |
| `total` | boolean | No | — | 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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. |
| `query` | string | No | — | Filters the result, showing only the records whose name matches the query. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"limit": {
"type": "integer",
"description": "The number of results per page."
},
"offset": {
"type": "integer",
"description": "Offset to start pagination search results."
},
"total": {
"type": "boolean",
"description": "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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information."
},
"query": {
"type": "string",
"description": "Filters the result, showing only the records whose name matches the query."
}
},
"required": [
"PCID",
"Accept",
"Content-Type"
]
}
```
***
## pagerduty\_operations\_list\_users
List users
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `query` | string | No | — | Filters the result, showing only the records whose name matches the query. |
| `team_ids` | string\[] | No | — | An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter. |
| `limit` | integer | No | — | The number of results per page. |
| `offset` | integer | No | — | Offset to start pagination search results. |
| `total` | boolean | No | — | 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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. |
| `include` | string | No | — | Array of additional Models to include in response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"query": {
"type": "string",
"description": "Filters the result, showing only the records whose name matches the query."
},
"team_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter."
},
"limit": {
"type": "integer",
"description": "The number of results per page."
},
"offset": {
"type": "integer",
"description": "Offset to start pagination search results."
},
"total": {
"type": "boolean",
"description": "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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information."
},
"include": {
"type": "string",
"description": "Array of additional Models to include in response.",
"enum": [
"contact_methods",
"notification_rules",
"teams",
"subdomains"
]
}
},
"required": [
"PCID",
"Accept",
"Content-Type"
]
}
```
***
## pagerduty\_operations\_update\_schedule
Update a schedule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `overflow` | boolean | No | — | Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`. |
| `schedule` | object | Yes | — | The schedule value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"overflow": {
"type": "boolean",
"description": "Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter `overflow=true` is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`."
},
"schedule": {
"description": "The schedule value"
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id",
"schedule"
]
}
```
***
## pagerduty\_operations\_update\_team
Update a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `team` | object | Yes | — | The team value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"team": {
"description": "The team value"
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id",
"team"
]
}
```
***
## pagerduty\_operations\_update\_team\_user
Add a user to a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `Accept` | string | Yes | — | The `Accept` header is used as a versioning header. |
| `Content-Type` | string | Yes | — | The content-type value |
| `id` | string | Yes | — | The ID of the resource. |
| `user_id` | string | Yes | — | The user ID on the team. |
| `role` | string | No | — | The role of the user on the team. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Accept": {
"type": "string",
"description": "The `Accept` header is used as a versioning header."
},
"Content-Type": {
"type": "string",
"description": "The content-type value",
"enum": [
"application/json"
]
},
"id": {
"type": "string",
"description": "The ID of the resource."
},
"user_id": {
"type": "string",
"description": "The user ID on the team."
},
"role": {
"type": "string",
"description": "The role of the user on the team.",
"enum": [
"observer",
"responder",
"manager"
]
}
},
"required": [
"PCID",
"Accept",
"Content-Type",
"id",
"user_id"
]
}
```