Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

status
enum<string>
Available options:
draft,
scheduled,
cancelled,
completed
kind
enum<string>

The same kinds Shifts uses. events is shown as Event.

Available options:
adoption,
fundraiser,
clinic,
transport,
training,
meeting,
events,
other
is_public
enum<string>

true for events marked public, false for internal ones. Any other value is ignored.

Available options:
true,
false
series_id
string

Every occurrence of one series: the series_id its events carry.

from
string<date>

Events starting on or after this day. Only the date is read.

to
string<date>

Events starting on or before the end of this day, UTC. Only the date is read.

sort
enum<string>
default:starts_at
Available options:
starts_at,
name,
status,
created_at
dir
enum<string>
default:asc
Available options:
asc,
desc
limit
integer
default:25

How many to return. 25 unless you say, 100 at most.

Required range: 1 <= x <= 100
offset
integer
default:0

How many to skip, for the next page.

Required range: x >= 0

Response

One page of events.

results
object[]
required
limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.

total
integer
required

How many events match in all.