Schemas

Public events with their start and end, time zone, venue or online flag, hosts, categories, ticket link and attendance.

Endpoints

4 endpoints return events on Facebook Events.

Schema

Single-item endpoints return this object as data; list endpoints return an array of them as data with a page object. The standard meta comes with every response.

platformstring

Platform ID (facebook, …).

idstring

Platform-native event ID (string; Facebook's numeric event ID).

urlstring uri

Canonical event page URL (https://www.facebook.com/events/<id>/).

namestring

The event's name as its page shows it.

descriptionstringnullable

Its description as plain text; null when it has none.

statusstring

At fetch time: scheduled (not started), ongoing (started, not over), ended (over), canceled (called off by its hosts); unknown when the source that answered does not show it (a fallback whose results hold only a name and a picture). New values may be added; treat any other value as unknown.

One ofscheduledongoingendedcanceledunknown

start_atstring date-timenullable

When it starts, RFC 3339 UTC; null only when the platform shows no start.

end_atstring date-timenullable

When it ends, RFC 3339 UTC; null when its hosts set no end or the platform does not show it.

time_zonestringnullable

The event's IANA time zone (America/New_York) when the platform states one; null otherwise (utc_offset_minutes still gives its local time).

utc_offset_minutesintegernullable

The event's offset from UTC at its start, in minutes (-240 for 5:00 PM EDT): its local start time is start_at plus this offset; null when unknown.

is_onlinebooleannullable

Held online (a stream or video call) rather than at a venue.

placeobjectnullable

Where it is held; null for an online event with no venue or when not shown.

ShowHide 8 child fields
idstringnullable

The place's ID as the platform's place endpoints key it (place.id); null for a venue given as free text.

namestringnullable

The place's name as shown (a venue's name, or the text its host typed).

urlstring urinullable

The place's page URL; null for a venue given as free text.

addressstringnullable

Address as the platform shows it (one line, not normalized).

citystringnullable

City or locality, as shown.

country_codestringnullable

ISO 3166-1 alpha-2 country of the place.

latitudenumbernullable

WGS 84 latitude in degrees; null when the platform shows no coordinates (set together with longitude).

longitudenumbernullable

WGS 84 longitude in degrees; null when the platform shows no coordinates (set together with latitude).

hostsobject[]

The accounts hosting it (pages and people), the main organizer first; [] when none are shown (listed in unknown_fields when the source cannot see them).

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

cover_urlstring urinullable

The event's cover image (a video cover's poster frame); null when it has none. Platform CDN URLs can expire within days.

categoriesstring[]

Categories the platform files it under, as shown (not normalized), the main one first; [] when none.

ticket_urlstring urinullable

Where to buy tickets or register, as the platform links it; null when none is linked.

parent_idstringnullable

ID of the event series this date belongs to (a recurring event's parent event); null for a single event or the series itself.

community_idstringnullable

ID of the community it belongs to (the Facebook group it was created in; community.id); null when none.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 1 child field
attendee_countintegernullable

People who said they are going (after the event: who went), as the platform counts them; null when not shown.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
facebookobjectnullable

A Facebook event's own fields.

ShowHide 7 child fields
ticket_providerstringnullable

Who sells the tickets ticket_url links to (Ticketmaster, Eventbrite), as Facebook names it; null when none.

price_textstringnullable

The ticket price or range as Facebook shows it ("$25 – $40", "Free"); null when none is shown.

date_textstringnullable

When it happens, as Facebook shows it, in the event's own time zone ("Sun, Nov 8 at 3:00 PM EST and 7 more", "Sat, Nov 21 - Nov 22", "Happening now"): on a recurring event its next date, where start_at is its first. Display text in the viewer's language; null when not shown.

frequencystringnullable

How often it repeats, as Facebook names it, lowercased (single for a one-off event); null when not shown.

occurrence_countintegernullable

Dates of its recurring series (the parent's child events); 0 for a single event.

city_idstringnullable

ID of the city Facebook files it under (its city Page, the number in facebook.com/events/explore/<city>/<id>/, which lists that city's events); place.city is the city's name. Null when not shown.

metricsobject

Facebook's own counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 2 child fields
interested_countintegernullable

People who marked themselves interested (not going), as Facebook counts them.

response_countintegernullable

People who responded going or interested, together, as Facebook counts them.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text ("7.3K interested": platform_specific.facebook.metrics.interested_count). [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

Item errors

Besides the request-level errors every endpoint can return, event endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).Check the link or ID. Do not retry.
private_or_unavailable403NoThe item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.Only public items can be fetched. Do not retry.

Last updated