Dev logo
API Walkthrough
Resources

List Organization Events

List all events for an organization, optionally filtered by date range and/or keyword. Does not include on-going service opportunities.

Request

Parameters

Field Label Type Description Required?
key string a valid API key required
org_id integer unique organization ID required
start_date date event start date (YYYY-MM-DD) optional
end_date date event end date (YYYY-MM-DD) optional
keyword string keyword(s) to search for events by name and description optional

Returns

Field Label Type Description
id integer unique event ID
is_public boolean is the event available to the public?
name string name of the event
location string location of the event
is_approved boolean is the event approved?
category hash a hash containing the id and name of the category the event is in
umbrella_category hash a hash containing the id and name of the category the event is in on the community calendar, not present if the event has not been shared to the community calendar
description string description of the event in plain text
html_description string description of the event in html format
rsvps integer number of people who have indicated they are attending the event
org_id integer unique organization ID
occurrences array of hashes an array of the individual occurrences comprising this event. Will contain multiple hashes if the event is recurring. Each hash will contain the following keys: starts_at, ends_at, and is_all_day. If this is an all-day event is_all_day with be true and starts_at and ends_at will be dates in the format YYYY-MM-DD. Note that the ends_at will be the following day for ICS compatibility. If this is NOT an all-day event is_all_day will be false and starts_at and ends_at will be datetimes in the format YYYY-MM-DDTHH:MM:SSZ

Sample Request

Sample Return