Skip to content

List events​

GET
/events

Live, listed, not suspended events as list rows: upcoming (soonest first, the default) or past (latest first). Feeds /events, city, community and host pages and the Fundly page. Filters take an id or a slug (member and fundraiser: an id). A sponsor's events are the ones it hosts and the ones it sponsors (sponsor_role for one of the two). A community's active members also get its members-only events that are not listed on /events (#2495). The first page (no cursor) says how many rows the filters match in all (total). No account needed; 404 while Events are switched off (features.events).

Authorizations​

or
BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Query Parameters

when
Type
string
Valid values
"upcoming""past"
Default
"upcoming"
city

A city place's id or slug.

Type
string
price
Type
string
Valid values
"free""paid"
community

Id or slug of a hosting community.

Type
string
organization

Id or slug of a hosting non-profit or church.

Type
string
sponsor

Id or slug of a sponsor that hosts or sponsors.

Type
string
sponsor_role

With sponsor (#2495), only the events it hosts or only the ones it sponsors; both when left out.

Type
string
Valid values
"hosting""sponsoring"
member

A hosting member.

Type
string
Format
"uuid"
fundraiser

A Fundly the events raise money for.

Type
string
Format
"uuid"
cursor

next_cursor of the page before.

Type
string
limit
Type
integer
Default
20
Maximum
50

Responses​

One page of rows.

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress