Retrieve a Shift

Endpoint

GET /api/shifts/{shift_id}/

Replace {shift_id} with the actual ID of the shift you wish to retrieve.

Example Request

GET /api/shifts/645dfb6c-437c-42a9-9cf7-2eaf9c0fa87d/

Authorization

Requests to this endpoint must include 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/645dfb6c-437c-42a9-9cf7-2eaf9c0fa87d/",
    headers=headers
)

Response Object

The response object includes details about a single shift, including timing, spot counts, and share URL:

{
  "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,
  "opportunity": {
    "id": "2f56f3ef-08f5-4e5a-bf5b-76ca8fc4d5f1",
    "created_at": "2026-02-02T10:15:00Z",
    "category": {
      "id": "d610ab31-e480-4ef1-9e35-94f94ebacde9",
      "title": "Community Outreach",
      "description": "Programs and roles related to outreach work."
    },
    "title": "Weekend Mentor",
    "description": "Support volunteers during weekend sessions.",
    "share_opportunity_url": "https://share.vomevolunteer.com/2f56f3ef-08f5-4e5a-bf5b-76ca8fc4d5f1"
  },
  "shift_location": "123 Main Street",
  "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."
}

Common errors:

  • 404 Not Found: The shift does not exist, or it does not belong to the authenticated institution.

Example:

Last updated