List schedules
curl --request GET \
--url https://{organization}.rescueconsole.com/api/shifts/schedules \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/shifts/schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/shifts/schedules"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"name": "<string>",
"starts_at": "<string>",
"status": "draft",
"all_day": true,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"location_unit_id": "<string>",
"ends_at": "<string>",
"event_kind": "adoption",
"signup_form_config": {},
"metadata": {},
"custom_fields": {},
"tenant_id": "<string>"
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123
}{
"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)"
}Shift schedules
List schedules
One page of your schedules, soonest start first unless you say otherwise. Deleted schedules are never listed. To filter on one of your own schedule fields, send cf_ and its key, such as cf_venue_contact=Ana. Needs read on Shifts.
GET
/
api
/
shifts
/
schedules
List schedules
curl --request GET \
--url https://{organization}.rescueconsole.com/api/shifts/schedules \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/shifts/schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/shifts/schedules"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"name": "<string>",
"starts_at": "<string>",
"status": "draft",
"all_day": true,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"location_unit_id": "<string>",
"ends_at": "<string>",
"event_kind": "adoption",
"signup_form_config": {},
"metadata": {},
"custom_fields": {},
"tenant_id": "<string>"
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123
}{
"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
How many to return. 25 unless you say, 100 at most.
Required range:
1 <= x <= 100How many to skip, for the next page.
Required range:
x >= 0Available options:
starts_at, ends_at, name, status, event_kind, created_at, updated_at Available options:
asc, desc One status. A draft schedule is not shown on the calendar.
Available options:
draft, scheduled, active, completed, cancelled One kind.
Available options:
adoption, fundraiser, clinic, transport, training, meeting, events, other Schedules at one location.
Schedules that start on or after this date, or date and time.
Schedules that start on or before this date, or date and time.
The name contains this text.
The description contains this text.
Available options:
yes, no Schedules that end on or after this.
Schedules that end on or before this.