List all Shifts

Endpoint and Request Method:

GET /api/shifts/

This endpoint retrieves a paginated list of all shifts for the authenticated institution.

Example Request:

GET https://api.vomevolunteer.com/api/shifts/

Authorization:

Requests to this endpoint require an API-KEY in the header for authentication.

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

response = requests.get(
    "https://api.vomevolunteer.com/api/shifts/",
    headers=headers
)

Supported query parameters:

• page: Page number.

• page_size: Number of results per page, up to 100.

• opportunity.id: Filters by related opportunity ID.

• opportunity_id: Alias for opportunity.id.

• opportunity_role_id: Alias for opportunity.id.

• category.id: Filters by related category ID.

• category_id: Alias for category.id.

Response Structure:

The response is a paginated object containing shift records. Each record represents a single shift along with its schedule, capacity details, and share URL.

Response Object:

{
  "count": 2,
  "next": "https://api.vomevolunteer.com/api/shifts/?page=2",
  "previous": null,
  "results": [
    {
      "id": "645dfb6c-437c-42a9-9cf7-2eaf9c0fa87d",
      "created_at": "2026-02-05T07:40:29.324645Z",
      "shift_start_at": "2026-02-12T09:00:00Z",
      "shift_end_at": "2026-02-12T13:00:00Z",
      "spots": 10,
      "spots_reserved": 4,
      "spots_available": 6,
      "shift_title": "Morning Shift",
      "shift_description": "Support setup and check-in.",
      "share_shift_url": "https://share.vomevolunteer.com/645dfb6c-437c-42a9-9cf7-2eaf9c0fa87d",
      "title": "Morning Shift",
      "description": "Support setup and check-in."
    },
    {
      "id": "89f72bc3-1b7b-43cf-9636-2d4a48e96d41",
      "created_at": "2026-02-07T11:10:00Z",
      "shift_start_at": "2026-02-13T14:00:00Z",
      "shift_end_at": "2026-02-13T17:00:00Z",
      "spots": 5,
      "spots_reserved": 1,
      "spots_available": 4,
      "shift_title": "Afternoon Shift",
      "shift_description": "Help run the afternoon session.",
      "share_shift_url": "https://share.vomevolunteer.com/89f72bc3-1b7b-43cf-9636-2d4a48e96d41",
      "title": "Afternoon Shift",
      "description": "Help run the afternoon session."
    }
  ]
}