> Documentation index for AI agents: https://docs.pagerduty.com/llms.txt

# List overrides

`GET https://api.pagerduty.com/v3/schedules/{id}/overrides`

<!-- theme: info -->

> **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:**
>
> 1. **Update your automations** to use the V3 API for all new shift-based schedules
> 2. **Keep the V2 endpoint** for your existing schedules
>
> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).

Retrieve overrides for a schedule within a time range.

**`since` and `until` are required.**

Returns every override that overlaps the window.

## Authorization

- **api_key** (apiKey) — `Authorization` header. The API Key with format `Token token=<API_KEY>`

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes | The ID of the schedule. |

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `since` | string (date-time) | yes | Start of time range (ISO 8601). Can be at most 2 years in the future. |
| `until` | string (date-time) | yes | End of time range (ISO 8601). Can be at most 2 years and 2 weeks in the future. |
| `time_zone` | string |  | IANA timezone identifier for rendering shift times. Defaults to the schedule's configured time zone. |
| `overflow` | boolean |  | Include shifts that extend beyond the requested time range boundaries. Default: `false`. |

## Response 200

Overrides retrieved successfully

### `application/json`

| Field | Type | Required | Description |
|---|---|---|---|
| `overrides` | array of object | yes |  |
| `overrides[].id` | string | yes |  |
| `overrides[].type` | string | yes | One of: `override_shift`. |
| `overrides[].rotation_id` | string |  | ID of the rotation whose shift is being overridden (mutually exclusive with custom_shift_id) |
| `overrides[].custom_shift_id` | string |  | ID of the custom shift being overridden (mutually exclusive with rotation_id) |
| `overrides[].start_time` | string (date-time) | yes |  |
| `overrides[].end_time` | string (date-time) | yes |  |
| `overrides[].overridden_member` | object | yes | A member (user) assigned to a shift or rotation slot. |
| `overrides[].overridden_member.type` | string | yes | `user_member` — a specific user is assigned. `empty_member` — the slot is intentionally unassigned. One of: `user_member`, `empty_member`. |
| `overrides[].overridden_member.user_id` | string |  | The ID of the user. Required when type is `user_member`. |
| `overrides[].overriding_member` | object | yes | A member (user) assigned to a shift or rotation slot. Same fields as `overrides[].overridden_member` above. |
| `overrides[].self` | string (uri) |  |  |
| `overrides[].html_url` | string (uri) |  |  |

Example: Example response

```json
{
  "overrides": []
}
```

## Response 400

Bad Request — The request contains invalid parameters or data

### `application/json`

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | object | yes |  |
| `error.message` | string | yes |  |
| `error.code` | integer | yes |  |
| `error.errors` | object |  | Map of field path to list of validation messages for that field. Field paths use dot notation prefixed by the resource type (e.g. `event.effective_since`, `rotation.events`). |

Example: default

```json
{
  "error": {
    "message": "Invalid Request",
    "code": 2001,
    "errors": {
      "event.effective_since": [
        "Date cannot be more than 12 months in the future"
      ]
    }
  }
}
```

## Response 401

Caller did not supply credentials or did not provide the correct credentials.
If you are using an API key, it may be invalid or your Authorization header may be malformed.

### `application/json`

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | object |  |  |
| `error.code` | integer |  | Read-only. |
| `error.message` | string |  | Error message string. Read-only. |
| `error.errors` | array of string |  | Read-only. |

## Response 403

Caller is not authorized to view the requested resource.
While your authentication is valid, the authenticated user or token does not have permission to perform this action.

### `application/json`

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | object |  |  |
| `error.code` | integer |  | Read-only. |
| `error.message` | string |  | Error message string. Read-only. |
| `error.errors` | array of string |  | Read-only. |

## Response 404

The requested resource was not found.

### `application/json`

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | object |  |  |
| `error.code` | integer |  | Read-only. |
| `error.message` | string |  | Error message string. Read-only. |
| `error.errors` | array of string |  | Read-only. |

## Response 500

Internal Server Error the PagerDuty server experienced an error.

### `application/json`

| Field | Type | Required | Description |
|---|---|---|---|
| `error` | object |  |  |
| `error.code` | integer |  | Read-only. |
| `error.message` | string |  | Error message string. Read-only. |
| `error.errors` | array of string |  | Read-only. |

## Developer Agreement

Your access to and use of the PagerDuty Developer Services is governed by the [PagerDuty Developer Agreement](https://docs.pagerduty.com/developer/pagerduty-developer-agreement).