List events
curl --request GET \
--url https://{organization}.rescueconsole.com/api/events/events \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/events/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/events/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"name": "<string>",
"starts_at": "<string>",
"all_day": true,
"status": "draft",
"is_public": true,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"summary": "<string>",
"description": "<string>",
"kind": "adoption",
"ends_at": "<string>",
"location_unit_id": "<string>",
"venue_organization_id": "<string>",
"venue_name": "<string>",
"venue_address": "<string>",
"registration_url": "<string>",
"form_slug": "<string>",
"shift_schedule_id": "<string>",
"series_id": "<string>",
"recurrence": {
"freq": "daily",
"interval": 1,
"by_weekday": [
3
],
"monthly_by": "date",
"until": "2023-12-25",
"count": 51,
"never_ends": true,
"tz": "<string>"
},
"animal_count": 123
}
],
"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)"
}Events
List events
One page of your events, soonest first unless you say otherwise, each with how many animals it lists. Deleted events are never listed. Every occurrence of a series is its own event here. Needs read on Events.
GET
/
api
/
events
/
events
List events
curl --request GET \
--url https://{organization}.rescueconsole.com/api/events/events \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/events/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/events/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"name": "<string>",
"starts_at": "<string>",
"all_day": true,
"status": "draft",
"is_public": true,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"summary": "<string>",
"description": "<string>",
"kind": "adoption",
"ends_at": "<string>",
"location_unit_id": "<string>",
"venue_organization_id": "<string>",
"venue_name": "<string>",
"venue_address": "<string>",
"registration_url": "<string>",
"form_slug": "<string>",
"shift_schedule_id": "<string>",
"series_id": "<string>",
"recurrence": {
"freq": "daily",
"interval": 1,
"by_weekday": [
3
],
"monthly_by": "date",
"until": "2023-12-25",
"count": 51,
"never_ends": true,
"tz": "<string>"
},
"animal_count": 123
}
],
"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
Available options:
draft, scheduled, cancelled, completed The same kinds Shifts uses. events is shown as Event.
Available options:
adoption, fundraiser, clinic, transport, training, meeting, events, other true for events marked public, false for internal ones. Any other value is ignored.
Available options:
true, false Every occurrence of one series: the series_id its events carry.
Events starting on or after this day. Only the date is read.
Events starting on or before the end of this day, UTC. Only the date is read.
Available options:
starts_at, name, status, created_at Available options:
asc, desc 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 >= 0