Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-24660315.0 KB
Events

Get Event

Return full details about an event you have manage access for, including hosts and a breakdown of guest counts by status.

get/v1/events/get

Query parameters

event_idstring required

Event ID, this usually starts with evt-

Event ID, this usually starts with evt-

Response

Successful response.

platform'luma' required
idstring required
user_idstring required
calendar_idstring required
start_atstring date-time required

ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z

duration_intervalstring required
end_atstring date-time required

ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z

created_atstring date-time required

ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z

timezonestring required

IANA Timezone, e.g. America/New_York. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

namestring required
meeting_urlstring nullable required
location_type'discord' | 'meet' | 'twitch' | 'twitter' | 'youtube' | 'zoom' | 'offline' | 'missing' | 'unknown' required

offline for in-person events. Online events have the meeting platform (zoom, meet, etc.), or unknown if we don't recognize the meeting link. missing if the event has no location set.

location_visibility'public' | 'guests-only' required

Whether the event's address is shown to everyone or only to approved guests. This API always returns the full address.

cover_urlstring required
urlstring required
visibility'public' | 'members-only' | 'private' required
waitlist_status'disabled' | 'enabled' required

enabled if the event has a waitlist. New registrations join the waitlist once the event reaches capacity.

registration_openboolean required

Whether the host is accepting registrations. When false, registration is closed and new guests can't sign up. Independent of capacity — a sold-out event with waitlist_status disabled still reports true.

require_approvalboolean required

true if registering requires host approval — i.e. any currently available ticket has approval turned on.

spots_remainingnumber nullable required

Spots left before the event hits its max capacity. Null when the event has no capacity limit (even if individual ticket types are capped). Refreshed by a background job, so this can lag a few seconds behind registrations.

access'manage' required
descriptionstring required
description_mdstring required