Skip to content
Try for free
On this page

Integrations

Luma

Manage events and guests on Luma

Use Luma to create, update, retrieve, or cancel events and list calendar events with date filters and pagination. Guest actions list attendees, retrieve an individual guest, add guests, send invitations, and change approval status.

Provide the calendar or event ID required by the operation, then inspect the returned event or guest details before sending invitations or changing attendance.

Use the block

Create, update, look up, and cancel events, list calendar events, manage guest lists (get one or many, add guests, send invites, and update approval status).

Actions

Luma Get Event

Retrieve details of a Luma event including name, time, location, hosts, and visibility settings.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringYesEvent ID (starts with evt-)

Output

ParameterTypeDescription
eventobjectEvent details
↳ idstringEvent ID
↳ namestringEvent name
↳ startAtstringEvent start time (ISO 8601)
↳ endAtstringEvent end time (ISO 8601)
↳ timezonestringEvent timezone (IANA)
↳ durationIntervalstringEvent duration (ISO 8601 interval, e.g. PT2H)
↳ createdAtstringEvent creation timestamp (ISO 8601)
↳ descriptionstringEvent description (plain text)
↳ descriptionMdstringEvent description (Markdown)
↳ coverUrlstringEvent cover image URL
↳ urlstringEvent page URL on lu.ma
↳ visibilitystringEvent visibility (public, members-only, private)
↳ meetingUrlstringVirtual meeting URL
↳ geoAddressJsonjsonStructured location/address data
↳ geoLatitudestringVenue latitude coordinate
↳ geoLongitudestringVenue longitude coordinate
↳ calendarIdstringAssociated calendar ID
hostsarrayEvent hosts
↳ idstringHost ID
↳ namestringHost display name
↳ firstNamestringHost first name
↳ lastNamestringHost last name
↳ emailstringHost email address
↳ avatarUrlstringHost avatar image URL

Luma Create Event

Create a new event on Luma with a name, start time, timezone, and optional details like description, location, and visibility.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
namestringYesEvent name/title
startAtstringYesEvent start time in ISO 8601 format (e.g., 2025-03-15T18:00:00Z)
timezonestringYesIANA timezone (e.g., America/New_York, Europe/London)
endAtstringNoEvent end time in ISO 8601 format (e.g., 2025-03-15T20:00:00Z)
durationIntervalstringNoEvent duration as ISO 8601 interval (e.g., PT2H for 2 hours, PT30M for 30 minutes). Used if endAt is not provided.
descriptionMdstringNoEvent description in Markdown format
meetingUrlstringNoVirtual meeting URL for online events (e.g., Zoom, Google Meet link)
visibilitystringNoEvent visibility: public, members-only, or private (defaults to public)
coverUrlstringNoCover image URL (must be a Luma CDN URL from images.lumacdn.com)

Output

ParameterTypeDescription
eventobjectCreated event details
↳ idstringEvent ID
↳ namestringEvent name
↳ startAtstringEvent start time (ISO 8601)
↳ endAtstringEvent end time (ISO 8601)
↳ timezonestringEvent timezone (IANA)
↳ durationIntervalstringEvent duration (ISO 8601 interval, e.g. PT2H)
↳ createdAtstringEvent creation timestamp (ISO 8601)
↳ descriptionstringEvent description (plain text)
↳ descriptionMdstringEvent description (Markdown)
↳ coverUrlstringEvent cover image URL
↳ urlstringEvent page URL on lu.ma
↳ visibilitystringEvent visibility (public, members-only, private)
↳ meetingUrlstringVirtual meeting URL
↳ geoAddressJsonjsonStructured location/address data
↳ geoLatitudestringVenue latitude coordinate
↳ geoLongitudestringVenue longitude coordinate
↳ calendarIdstringAssociated calendar ID
hostsarrayEvent hosts
↳ idstringHost ID
↳ namestringHost display name
↳ firstNamestringHost first name
↳ lastNamestringHost last name
↳ emailstringHost email address
↳ avatarUrlstringHost avatar image URL

Luma Update Event

Update an existing Luma event. Only the fields you provide will be changed; all other fields remain unchanged.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringYesEvent ID to update (starts with evt-)
namestringNoNew event name/title
startAtstringNoNew start time in ISO 8601 format (e.g., 2025-03-15T18:00:00Z)
timezonestringNoNew IANA timezone (e.g., America/New_York, Europe/London)
endAtstringNoNew end time in ISO 8601 format (e.g., 2025-03-15T20:00:00Z)
durationIntervalstringNoNew duration as ISO 8601 interval (e.g., PT2H for 2 hours). Used if endAt is not provided.
descriptionMdstringNoNew event description in Markdown format
meetingUrlstringNoNew virtual meeting URL (e.g., Zoom, Google Meet link)
visibilitystringNoNew visibility: public, members-only, or private
coverUrlstringNoNew cover image URL (must be a Luma CDN URL from images.lumacdn.com)

Output

ParameterTypeDescription
eventobjectUpdated event details
↳ idstringEvent ID
↳ namestringEvent name
↳ startAtstringEvent start time (ISO 8601)
↳ endAtstringEvent end time (ISO 8601)
↳ timezonestringEvent timezone (IANA)
↳ durationIntervalstringEvent duration (ISO 8601 interval, e.g. PT2H)
↳ createdAtstringEvent creation timestamp (ISO 8601)
↳ descriptionstringEvent description (plain text)
↳ descriptionMdstringEvent description (Markdown)
↳ coverUrlstringEvent cover image URL
↳ urlstringEvent page URL on lu.ma
↳ visibilitystringEvent visibility (public, members-only, private)
↳ meetingUrlstringVirtual meeting URL
↳ geoAddressJsonjsonStructured location/address data
↳ geoLatitudestringVenue latitude coordinate
↳ geoLongitudestringVenue longitude coordinate
↳ calendarIdstringAssociated calendar ID
hostsarrayEvent hosts
↳ idstringHost ID
↳ namestringHost display name
↳ firstNamestringHost first name
↳ lastNamestringHost last name
↳ emailstringHost email address
↳ avatarUrlstringHost avatar image URL

Luma List Events

List events from your Luma calendar with optional date range filtering, sorting, and pagination.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
afterstringNoReturn events after this ISO 8601 datetime (e.g., 2025-01-01T00:00:00Z)
beforestringNoReturn events before this ISO 8601 datetime (e.g., 2025-12-31T23:59:59Z)
paginationLimitnumberNoMaximum number of events to return per page
paginationCursorstringNoPagination cursor from a previous response (next_cursor) to fetch the next page of results
sortColumnstringNoColumn to sort by (only start_at is supported)
sortDirectionstringNoSort direction: asc, desc, asc nulls last, or desc nulls last

Output

ParameterTypeDescription
eventsarrayList of calendar events
↳ idstringEvent ID
↳ namestringEvent name
↳ startAtstringEvent start time (ISO 8601)
↳ endAtstringEvent end time (ISO 8601)
↳ timezonestringEvent timezone (IANA)
↳ durationIntervalstringEvent duration (ISO 8601 interval, e.g. PT2H)
↳ createdAtstringEvent creation timestamp (ISO 8601)
↳ descriptionstringEvent description (plain text)
↳ descriptionMdstringEvent description (Markdown)
↳ coverUrlstringEvent cover image URL
↳ urlstringEvent page URL on lu.ma
↳ visibilitystringEvent visibility (public, members-only, private)
↳ meetingUrlstringVirtual meeting URL
↳ geoAddressJsonjsonStructured location/address data
↳ geoLatitudestringVenue latitude coordinate
↳ geoLongitudestringVenue longitude coordinate
↳ calendarIdstringAssociated calendar ID
hasMorebooleanWhether more results are available for pagination
nextCursorstringCursor to pass as paginationCursor to fetch the next page

Luma Lookup Event

Look up an event by its public URL or event ID to resolve its canonical ID, API ID, and approval status.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
urlstringNoPublic event URL on lu.ma (provide this or an event ID)
eventIdstringNoEvent ID to look up (starts with evt-). Provide this or a URL.
platformstringNoEvent platform to look up: luma or external (defaults to luma)

Output

ParameterTypeDescription
foundbooleanWhether a matching event was found
eventIdstringResolved event ID
apiIdstringResolved event API ID (deprecated identifier)
statusstringEvent approval status (approved, pending, rejected)

Luma Cancel Event

Cancel a Luma event. This is irreversible and notifies all registered guests. Requires a cancellation token obtained from the Request Event Cancellation endpoint.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringYesEvent ID to cancel (starts with evt-)
cancellationTokenstringYesCancellation token from the Request Event Cancellation endpoint (POST /v1/event/cancel/request)
shouldRefundbooleanNoWhether to refund paid guests. Required if the event has paid registrations.

Output

ParameterTypeDescription
cancelledbooleanWhether the event was successfully cancelled

Luma Get Guests

Retrieve the guest list for a Luma event with optional filtering by approval status, sorting, and pagination.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringYesEvent ID (starts with evt-)
approvalStatusstringNoFilter by approval status: approved, session, pending_approval, invited, declined, or waitlist
paginationLimitnumberNoMaximum number of guests to return per page
paginationCursorstringNoPagination cursor from a previous response (next_cursor) to fetch the next page of results
sortColumnstringNoColumn to sort by: name, email, created_at, registered_at, or checked_in_at
sortDirectionstringNoSort direction: asc, desc, asc nulls last, or desc nulls last

Output

ParameterTypeDescription
guestsarrayList of event guests
↳ idstringGuest ID
↳ emailstringGuest email address
↳ namestringGuest full name
↳ firstNamestringGuest first name
↳ lastNamestringGuest last name
↳ approvalStatusstringGuest approval status (approved, session, pending_approval, invited, declined, waitlist)
↳ registeredAtstringRegistration timestamp (ISO 8601)
↳ invitedAtstringInvitation timestamp (ISO 8601)
↳ joinedAtstringJoin timestamp (ISO 8601)
↳ checkedInAtstringCheck-in timestamp from the first checked-in ticket (ISO 8601)
↳ phoneNumberstringGuest phone number
hasMorebooleanWhether more results are available for pagination
nextCursorstringCursor to pass as paginationCursor to fetch the next page

Luma Get Guest

Retrieve a single guest's details on a Luma event, including approval status, registration timestamps, and contact info.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringYesEvent ID the guest belongs to (starts with evt-)
guestIdentifierstringYesGuest ID (gst-...), guest key (g-...), ticket key, or the guest's email address

Output

ParameterTypeDescription
guestobjectGuest details
↳ idstringGuest ID
↳ emailstringGuest email address
↳ namestringGuest full name
↳ firstNamestringGuest first name
↳ lastNamestringGuest last name
↳ approvalStatusstringGuest approval status (approved, session, pending_approval, invited, declined, waitlist)
↳ registeredAtstringRegistration timestamp (ISO 8601)
↳ invitedAtstringInvitation timestamp (ISO 8601)
↳ joinedAtstringJoin timestamp (ISO 8601)
↳ checkedInAtstringCheck-in timestamp from the first checked-in ticket (ISO 8601)
↳ phoneNumberstringGuest phone number

Luma Add Guests

Add guests to a Luma event by email. Guests are added with Going (approved) status and receive one ticket of the default ticket type.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringYesEvent ID (starts with evt-)
guestsstringYesJSON array of guest objects. Each guest requires an "email" field and optionally "name", "first_name", "last_name". Example: [{"email": "user@example.com", "name": "John Doe"}]

Output

ParameterTypeDescription
addednumberNumber of guests submitted to the event (added with Going/approved status)

Luma Send Invites

Send email invitations to guests for a Luma event. Unlike Add Guests (which registers guests directly), this emails an invite that recipients can accept.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringYesEvent ID to invite guests to (starts with evt-)
guestsstringYesJSON array of guest objects. Each guest requires an "email" field and optionally "name". Example: [{"email": "user@example.com", "name": "John Doe"}]
messagestringNoOptional custom message included in the invite email (max 200 characters)

Output

ParameterTypeDescription
invitednumberNumber of guests invited to the event

Luma Update Guest Status

Update a guest's approval status on a Luma event — approve, decline, waitlist, or set to pending. Identify the guest by email or guest ID.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesLuma API key
eventIdstringNoEvent ID the guest belongs to (starts with evt-)
guestIdentifierstringYesGuest email address or guest ID (gst-...). Values containing '@' are treated as emails; otherwise as a guest ID.
statusstringYesNew approval status: approved, declined, pending_approval, or waitlist
shouldRefundbooleanNoRefund a paid guest when moving them out of an approved state (defaults to false)
sendEmailbooleanNoWhether to email the guest about the status change (defaults to true)

Output

ParameterTypeDescription
statusstringThe approval status applied to the guest
gueststringThe guest identifier (email or ID) that was updated
Was this helpful?
Suggest an edit