curl --request GET \
--url https://{organization}.rescueconsole.com/api/shifts/bookings \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/shifts/bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/shifts/bookings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"window_role_id": "<string>",
"person_id": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"status": "booked",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"window_id": "<string>",
"companions": [
{
"person_id": "<string>",
"relationship": "guardian",
"booking_id": "<string>",
"person_name": "<string>"
}
],
"tenant_id": "<string>",
"hours_logged": 1,
"signed_off_by": "<string>",
"signed_off_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"cancellation_requested_at": "2023-11-07T05:31:56Z",
"cancellation_reason": "<string>",
"cancellation_decision": "released",
"cancellation_decided_by": "<string>",
"cancellation_decided_at": "2023-11-07T05:31:56Z",
"cancellation_decision_notes": "<string>",
"custom_fields": "<string>",
"role_label": "<string>",
"role_key": "<string>",
"window_starts_at": "2023-11-07T05:31:56Z",
"window_ends_at": "2023-11-07T05:31:56Z",
"location_unit_id": "<string>",
"window_status": "open",
"person_name": "<string>"
}
],
"total": 123,
"limit": 123,
"offset": 123,
"has_more": true
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}List sign-ups
The roster: one page of sign-ups, soonest first, with the role, the shift and the volunteer’s name. Given-up sign-ups are left out unless you ask for them by status. Needs read on Shifts. A key with read on People sees every sign-up. A key without it sees the roster of the person who created the key: their own sign-ups, the ones they accompany, and the other sign-ups on shifts they are on, cut down to who, which role and when, and marked is_peer.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/shifts/bookings \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/shifts/bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/shifts/bookings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"window_role_id": "<string>",
"person_id": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"status": "booked",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"window_id": "<string>",
"companions": [
{
"person_id": "<string>",
"relationship": "guardian",
"booking_id": "<string>",
"person_name": "<string>"
}
],
"tenant_id": "<string>",
"hours_logged": 1,
"signed_off_by": "<string>",
"signed_off_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"cancellation_requested_at": "2023-11-07T05:31:56Z",
"cancellation_reason": "<string>",
"cancellation_decision": "released",
"cancellation_decided_by": "<string>",
"cancellation_decided_at": "2023-11-07T05:31:56Z",
"cancellation_decision_notes": "<string>",
"custom_fields": "<string>",
"role_label": "<string>",
"role_key": "<string>",
"window_starts_at": "2023-11-07T05:31:56Z",
"window_ends_at": "2023-11-07T05:31:56Z",
"location_unit_id": "<string>",
"window_status": "open",
"person_name": "<string>"
}
],
"total": 123,
"limit": 123,
"offset": 123,
"has_more": true
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Query Parameters
One or more of booked, cancellation_requested, cancelled, attended, no_show, separated by commas. Without it, every status but cancelled.
The sign-ups of one person (not the ones they accompany).
The sign-ups on one shift.
The sign-ups for one role.
The sign-ups on shifts at one location.
Sign-ups that end on or after this date, or date and time.
Sign-ups that start on or before this date, or date and time.
false for the hours still waiting to be signed off.
true, false How many to return. 50 unless you say, 200 at most.
1 <= x <= 200How many to skip, for the next page.
x >= 0