Skip to main content
GET
List activity

Authorizations

Authorization
string
header
required

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

Query Parameters

module
enum<string>

Only changes in this area. An area your key may not read answers 403 rather than an empty list. An area of your organization, as a key's permissions name it.

Available options:
people,
organizations,
animals,
fundraising,
shifts,
events,
registry,
communications
entity_type
string

Only changes to this kind of record, such as animal, person, donation or adoption_application.

entity_id
string

Only changes to the record with this record ID.

person_id
string

Everything about one person: changes to their own record, changes to records that name them as their person (a booking, a donation, an adoption), and bookings they came along to as a companion. Still only in areas your key may read.

action
enum<string>
Available options:
create,
update,
delete,
state_change
period
enum<string>

Only changes in the last 24 hours, 7 days, 30 days or 90 days, counted back from now. 1d is the last 24 hours; 7d, 30d and 90d the last 7, 30 and 90 days.

Available options:
1d,
7d,
30d,
90d
limit
integer
default:50

How many to return. 50 unless you say, 200 at most.

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

How many to skip, for the next page.

Required range: x >= 0

Response

One page of changes. There is no total; use has_more to page, or Count activity for the numbers.

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

Whether there is another page after this one.