List all reservations
Endpoint and Request Method:
GET
/api/reservations/This endpoint is used to retrieve a list of all reservations.
Example Request:
GET https://api.vomevolunteer.com/api/reservations/
Authorization:
Requests to this endpoint require an
API-KEYin the header for authentication.
headers = {
"API-KEY": "your_unique_api_key_here"
}
response = requests.get("https://api.vomevolunteer.com/api/reservations/", headers=headers)Response Structure:
The response is an array of objects, each representing a reservation along with associated details about the shift, user, and opportunity.
Response Object:
{
"count": 832,
"next": "http://3.96.242.26:8030/api/reservations/?page=2",
"previous": null,
"results": [
{
"id": "3b87b2ee-5063-471d-a70a-051d165ca1d0",
"shift": {
"id": "1f7bb9e7-d891-42bc-b2a5-533cc02ad480",
"created_at": "2021-07-07T15:41:20.968717Z",
"shift_start_at": "2021-07-14T17:00:00Z",
"shift_end_at": "2021-07-14T19:00:00Z",
"spots": 1,
"shift_title": "Shift Title A",
"shift_description": null
},
"created_at": "2021-07-07T15:41:20.970080Z",
"status": 6, //Hours logged,
"logged_hours": 2.25,
"arrival_time": "2021-07-14T17:00:00Z",
"departure_time": "2021-07-14T19:00:00Z",
"hours_approved_by": {
"first_name": "Daniella",
"last_name": "Smith",
"email": "[email protected]"
},
"user": {
"id": "443f05ad-b1be-43bc-a213-3483471bc7fa",
"first_name": "Lela",
"last_name": "Craig",
"email": "[email protected]",
"gender": 1, //Female
"address": "3949 Decarie Boulevard, Montreal, QC, Canada",
"phone_number": "929384838",
"date_of_birth": "1973-03-04",
"timezone": "America/Toronto",
"address_coordinates": [
"45.5011136",
"-73.5793778"
]
},
"opportunity": {
"id": "14e21aad-869d-4384-be7b-e12cb8c0dc3d",
"category": {
"id": "9d20cefb-002a-42d9-bce4-9937dd8444b5",
"title": "Program ABC",
"description": "Description of Program ABC"
},
"title": "Transportation",
"description": "Description of transportation"
}
},
]
}
Last updated