For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Retrieve a shift series

Returns one series with its recurrence, its end date, the derived counts, and its template.

Endpoint

GET /api/shift-series/{series_id}/

The template

The response includes template_detail: the series template with every related record resolved into a full object (location, policies, tags, coordinators, watchers) rather than bare IDs. This is what you would prefill an editor from, and it is the shape a single shift's detail takes, so one editor can serve both.

The template is the skeleton every future occurrence is built from. Changing it is Edit a shift series.

Request sample

import requests

headers = {"API-KEY": "your_unique_api_key_here"}

response = requests.get(
    "https://api.vomevolunteer.com/api/shift-series/7c0f3f20-6e39-4b80-bb35-7d743f0193a6/",
    headers=headers,
)

Response sample

{
  "id": "7c0f3f20-6e39-4b80-bb35-7d743f0193a6",
  "opportunity_role": "2f56f3ef-08f5-4e5a-bf5b-76ca8fc4d5f1",
  "status": "active",
  "starts_at": "2026-11-10T19:00:00Z",
  "ends_at": null,
  "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,
  "customized_shifts_count": 2,
  "pending_exceptions_count": 1,
  "template_detail": {
    "shift_title": "Evening meal service",
    "spots": 12,
    "shift_location": null,
    "shift_coordinators": [],
    "shift_tags": []
  }
}