> For the complete documentation index, see [llms.txt](https://docs.vomevolunteer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vomevolunteer.com/resources/schedule/shift-series/the-shift-series-object.md).

# The Shift Series Object

A series describes how a shift repeats. The individual shifts it produces are ordinary [Shift objects](https://docs.vomevolunteer.com/resources/schedule/shifts/the-shift-object.md), each one pointing back at the series it came from.

### Attributes

| Field                        | Type             | Description                                                                  |
| ---------------------------- | ---------------- | ---------------------------------------------------------------------------- |
| `id`                         | uuid             | The series.                                                                  |
| `opportunity_role`           | uuid             | The opportunity the series belongs to.                                       |
| `status`                     | string           | `active` while it is still generating, `ended` once it has stopped.          |
| `starts_at`                  | datetime         | The first occurrence, and the anchor the recurrence counts from.             |
| `ends_at`                    | datetime or null | When the series stops. `null` means open-ended.                              |
| `recurrence`                 | object           | The repeat rule.                                                             |
| `repeats`                    | string           | The rule in plain English, for example `Every week on Tue, Thu, open-ended`. |
| `generated_through_at`       | datetime         | How far ahead Vome has created real shifts so far.                           |
| `future_active_shifts_count` | integer          | Upcoming shifts that exist right now.                                        |
| `total_shifts_count`         | integer          | Every shift the series has ever produced.                                    |
| `active_enrollments_count`   | integer          | Volunteers currently committed to the series.                                |
| `customized_shifts_count`    | integer          | Shifts somebody edited individually. See below.                              |
| `pending_exceptions_count`   | integer          | Occurrences skipped or changed before they were generated.                   |
| `shift_title`                | string           | The title the series gives each shift.                                       |
| `opportunity_role_title`     | string           | The opportunity, as it is called in Vome.                                    |
| `opportunity_title`          | string           | The category the opportunity sits in.                                        |
| `timezone`                   | string           | The zone the series is read in.                                              |
| `sites`                      | array            | Sites the series is linked to.                                               |

### Sample

```json
{
  "id": "7c0f3f20-6e39-4b80-bb35-7d743f0193a6",
  "opportunity_role": "2f56f3ef-08f5-4e5a-bf5b-76ca8fc4d5f1",
  "opportunity_role_title": "Evening meal service",
  "opportunity_title": "Food Services",
  "status": "active",
  "starts_at": "2026-11-10T19:00:00Z",
  "ends_at": null,
  "repeats": "Every week on Tue, Thu, open-ended",
  "recurrence": {
    "frequency": "weekly",
    "interval": 1,
    "byweekday": [1, 3]
  },
  "generated_through_at": "2027-05-10T00:00:00Z",
  "future_active_shifts_count": 52,
  "total_shifts_count": 52,
  "active_enrollments_count": 4,
  "customized_shifts_count": 2,
  "pending_exceptions_count": 1,
  "timezone": "America/Toronto"
}
```

### Customized shifts and pending exceptions

These two counts answer different questions, and both matter before you edit a series.

`customized_shifts_count` counts shifts that **already exist** and that somebody edited on their own, for example changing the spots on one Thursday. Those shifts keep their edits: a later series-wide edit skips them, the way a single changed meeting in Outlook keeps its change. Pass `clear_overrides` on an edit to pull them back in line.

`pending_exceptions_count` counts occurrences that were cancelled or changed **before Vome generated them**. They are applied when the date comes around.
