Skip to content

Events​

Events (#2483): the list of live events, an event page with its viewer block, and the forms on it (volunteer, sponsor this dinner, report). Behind features.events: while it is off every operation answers 404, except to staff with manage_events. Drafts, events in review and suspended events answer 404 to anyone but their hosts and staff. Refusals come as EventError.


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​


Event link-preview image​

GET
/events/slug/{slug}/og-image

The event's 1200×630 Open Graph picture: its complete cover fitted inside the frame without cropping invitation text or logos, or a card with its title, date and place. Public and cached for five minutes, one answer per URL whoever asks; an event a stranger may not see is the same 404 as an unknown link.

Parameters​

Path Parameters

slug*
Type
string
Required

Query Parameters

lang

Language to render in. Without it the locale cookie, then Accept-Language, decide.

Type
string
Valid values
"en""ru""uk""es"
v

The cover and preview-layout version, so a new cover or layout is a new URL. Ignored by the server.

Type
string
shape

The complete cover fitted inside this shape. Unused space uses the event theme background.

Type
string
Valid values
"square""4x3""16x9"

Responses​

The picture.

Playground​

Server
Variables
Key
Value

Samples​


Event square share poster​

GET
/events/slug/{slug}/share-poster

A 1080×1080 picture for feed posts (#2490). Same data, language rules, caching and 404 as the link-preview image.

Parameters​

Path Parameters

slug*
Type
string
Required

Query Parameters

lang

Language to render in. Without it the locale cookie, then Accept-Language, decide.

Type
string
Valid values
"en""ru""uk""es"
v

The cover's version, so a new cover is a new URL. Ignored by the server.

Type
string

Responses​

The picture.

Playground​

Server
Variables
Key
Value

Samples​


Event story card​

GET
/events/slug/{slug}/share-story

A 1080×1920 picture for Instagram and Facebook Stories (#2490). Same data, language rules, caching and 404 as the link-preview image.

Parameters​

Path Parameters

slug*
Type
string
Required

Query Parameters

lang

Language to render in. Without it the locale cookie, then Accept-Language, decide.

Type
string
Valid values
"en""ru""uk""es"
v

The cover's version, so a new cover is a new URL. Ignored by the server.

Type
string

Responses​

The picture.

Playground​

Server
Variables
Key
Value

Samples​


The event page​

GET
/events/slug/{slug}

The event, its days, hosts, ticket types with availability, sponsors, volunteer roles with open slots, linked Fundlies with raised, photos, the computed sale status and the viewer block. A live event that is not suspended is public; a draft, an event in review, with changes requested, rejected or suspended answers 404 to anyone but its hosts and staff. An old link answers 301 to the current one. Never cached by a shared cache.

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​

Path Parameters

slug*
Type
string
Required

Responses​

The page.

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


People going to an event​

GET
/events/{id}/going

A private, no-store, paginated identity list. Public readers see only active opted-in buyer profiles. Accepted hosts and authorized event staff may also see member guests and named guests without accounts. Emails, booking/payment details and ticket codes are never included. The event-page visibility gate applies; hidden attendee lists return 404. Each request rechecks the viewer's access.

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​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Query Parameters

cursor
Type
string
limit
Type
integer
Default
25
Minimum
1
Maximum
100

Responses​

The people visible to this viewer, the total attendance count and next cursor.

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


Volunteer from the page​

POST
/events/{id}/volunteer-signups

A sign-up to a role open to sign-ups, on a live event that has not ended, for the hosts to approve (requested). Signed in, the person is the volunteer; signed out, name and email are required. 5 a minute per address.

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​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"profile_id": "string",
"name": "string",
"email": "string",
"phone": "string",
"note": "string"
}

Responses​

Signed up.

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Variables
Key
Value
Body

Samples​


"Sponsor this dinner"​

POST
/events/{id}/sponsor-requests

A business asks to sponsor a live event that has not ended; the hosts see it in the Sponsors tab. 5 a minute per address.

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​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"business_name": "string",
"contact_name": "string",
"email": "string",
"message": "string"
}

Responses​

Sent.

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Variables
Key
Value
Body

Samples​


Report an event​

POST
/events/{id}/report

"Something wrong with this event? Report". Signed in with a verified email; one report per person and event (a second replaces the first). Hosts cannot report their own event. Staff review reports; nothing is taken down automatically.

Authorizations​

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​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"reason": "string",
"details": "string"
}

Responses​

Reported.

application/json
JSON
{
"id": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Powered by VitePress OpenAPI

Built with VitePress