List Events
Retrieve a paginated list of events. Filter by status, type, date range, or public visibility.Query Parameters
integer
default:"1"
Page number to retrieve.
integer
default:"25"
Number of records per page. Maximum
100.string
Filter by event status. One of
draft, scheduled, completed, or cancelled.string
Filter by event type. One of
adoption-day, fundraiser, clinic, training, or meeting.boolean
When
true, returns only events published to your public website. When false, returns only non-public events.string
Return events that start on or after this date and time. Format: ISO 8601 (e.g.
2026-10-01T00:00:00Z).string
Return events that start on or before this date and time. Format: ISO 8601.
Example Request
Response
Retrieve an Event
Fetch the full record for a single event by ID.Path Parameters
string
required
The unique ID of the event record.
Example Request
Response Fields
string
The unique identifier for this event record.
string
The event name as it appears internally and, when published, on your public website.
string
The event type. One of
adoption-day, fundraiser, clinic, training, or meeting.string
The current event status. One of
draft (not yet finalized), scheduled (confirmed and upcoming), completed (the event has passed), or cancelled (the event was called off).string (ISO 8601)
The date and time the event starts, in UTC.
string (ISO 8601)
The date and time the event ends, in UTC. May be
null if no end time has been set.string
The ID of the location where the event takes place. May be
null for virtual or off-site events with no location record.boolean
Whether this event is currently published to your public website.
string
A description of the event. Shown on your public website when the event is published. May be
null.array of strings
IDs of animal records attending this event. These animals are featured on the public event listing when
isPublic is true.string (ISO 8601)
Timestamp when the event record was created.
Create an Event
Add a new event to your organization’s calendar.Request Body
string
required
The event name.
string
required
The event type. One of
adoption-day, fundraiser, clinic, training, or meeting.string
default:"draft"
The initial status. One of
draft or scheduled. Defaults to draft.string
required
Event start date and time in ISO 8601 format (e.g.
2026-10-04T10:00:00Z).string
Event end date and time in ISO 8601 format. Recommended but not required.
string
The ID of the location where the event takes place.
boolean
default:"false"
Set to
true to immediately publish this event to your public website on creation.string
A description of the event. Shown publicly when
isPublic is true.array of strings
IDs of animal records to associate with this event. These animals appear on the public event listing.
Example Request
Response
Returns201 Created with the full event record as the response body.
Update an Event
Update one or more fields on an existing event. Only fields included in the request body are changed.Path Parameters
string
required
The unique ID of the event record to update.
Request Body
All fields are optional. Include only what you want to change.string
Updated event name.
string
Updated event type. One of
adoption-day, fundraiser, clinic, training, or meeting.string
Updated event status. One of
draft, scheduled, completed, or cancelled.string
Updated start date and time in ISO 8601 format.
string
Updated end date and time in ISO 8601 format. Pass
null to clear the end time.string
Updated location ID. Pass
null to remove the location association.boolean
Set to
true to publish this event to your public website; false to unpublish it.string
Updated event description. Pass an empty string to clear it.
array of strings
Updated list of animal IDs attending this event. This replaces the entire
animals array — include all animals you want associated after the update.Example Request
Response
Returns200 OK with the full updated event record as the response body.
Event Types Reference
adoption-day
adoption-day
A public adoption event where attendees can meet and adopt animals. Link animals to this event type to feature them on your public website’s event listing.
fundraiser
fundraiser
A fundraising event such as a gala, auction, or benefit. Fundraiser events can appear on your public site to drive attendance and donations.
clinic
clinic
A veterinary or wellness clinic — for example, a low-cost vaccine day or a microchip clinic open to the public or restricted to your fosters.
training
training
A training session for volunteers or staff. Typically kept private (
isPublic: false), but can be published if open to the public.meeting
meeting
An internal team or board meeting. Generally kept private.