Luma

Instructions d'utilisation

Integrate Luma into the workflow. Can 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).

Outils

`luma_get_event`

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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Oui	Event ID (starts with evt-)

Sortie

Paramètre	Type	Description
`event`	object	Event details
↳ `id`	string	Event ID
↳ `name`	string	Event name
↳ `startAt`	string	Event start time (ISO 8601)
↳ `endAt`	string	Event end time (ISO 8601)
↳ `timezone`	string	Event timezone (IANA)
↳ `durationInterval`	string	Event duration (ISO 8601 interval, e.g. PT2H)
↳ `createdAt`	string	Event creation timestamp (ISO 8601)
↳ `description`	string	Event description (plain text)
↳ `descriptionMd`	string	Event description (Markdown)
↳ `coverUrl`	string	Event cover image URL
↳ `url`	string	Event page URL on lu.ma
↳ `visibility`	string	Event visibility (public, members-only, private)
↳ `meetingUrl`	string	Virtual meeting URL
↳ `geoAddressJson`	json	Structured location/address data
↳ `geoLatitude`	string	Venue latitude coordinate
↳ `geoLongitude`	string	Venue longitude coordinate
↳ `calendarId`	string	Associated calendar ID
`hosts`	array	Event hosts
↳ `id`	string	Host ID
↳ `name`	string	Host display name
↳ `firstName`	string	Host first name
↳ `lastName`	string	Host last name
↳ `email`	string	Host email address
↳ `avatarUrl`	string	Host 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.

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`name`	string	Oui	Event name/title
`startAt`	string	Oui	Event start time in ISO 8601 format (e.g., 2025-03-15T18:00:00Z)
`timezone`	string	Oui	IANA timezone (e.g., America/New_York, Europe/London)
`endAt`	string	Non	Event end time in ISO 8601 format (e.g., 2025-03-15T20:00:00Z)
`durationInterval`	string	Non	Event duration as ISO 8601 interval (e.g., PT2H for 2 hours, PT30M for 30 minutes). Used if endAt is not provided.
`descriptionMd`	string	Non	Event description in Markdown format
`meetingUrl`	string	Non	Virtual meeting URL for online events (e.g., Zoom, Google Meet link)
`visibility`	string	Non	Event visibility: public, members-only, or private (defaults to public)
`coverUrl`	string	Non	Cover image URL (must be a Luma CDN URL from images.lumacdn.com)

Sortie

Paramètre	Type	Description
`event`	object	Created event details
↳ `id`	string	Event ID
↳ `name`	string	Event name
↳ `startAt`	string	Event start time (ISO 8601)
↳ `endAt`	string	Event end time (ISO 8601)
↳ `timezone`	string	Event timezone (IANA)
↳ `durationInterval`	string	Event duration (ISO 8601 interval, e.g. PT2H)
↳ `createdAt`	string	Event creation timestamp (ISO 8601)
↳ `description`	string	Event description (plain text)
↳ `descriptionMd`	string	Event description (Markdown)
↳ `coverUrl`	string	Event cover image URL
↳ `url`	string	Event page URL on lu.ma
↳ `visibility`	string	Event visibility (public, members-only, private)
↳ `meetingUrl`	string	Virtual meeting URL
↳ `geoAddressJson`	json	Structured location/address data
↳ `geoLatitude`	string	Venue latitude coordinate
↳ `geoLongitude`	string	Venue longitude coordinate
↳ `calendarId`	string	Associated calendar ID
`hosts`	array	Event hosts
↳ `id`	string	Host ID
↳ `name`	string	Host display name
↳ `firstName`	string	Host first name
↳ `lastName`	string	Host last name
↳ `email`	string	Host email address
↳ `avatarUrl`	string	Host avatar image URL

`luma_update_event`

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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Oui	Event ID to update (starts with evt-)
`name`	string	Non	New event name/title
`startAt`	string	Non	New start time in ISO 8601 format (e.g., 2025-03-15T18:00:00Z)
`timezone`	string	Non	New IANA timezone (e.g., America/New_York, Europe/London)
`endAt`	string	Non	New end time in ISO 8601 format (e.g., 2025-03-15T20:00:00Z)
`durationInterval`	string	Non	New duration as ISO 8601 interval (e.g., PT2H for 2 hours). Used if endAt is not provided.
`descriptionMd`	string	Non	New event description in Markdown format
`meetingUrl`	string	Non	New virtual meeting URL (e.g., Zoom, Google Meet link)
`visibility`	string	Non	New visibility: public, members-only, or private
`coverUrl`	string	Non	New cover image URL (must be a Luma CDN URL from images.lumacdn.com)

Sortie

Paramètre	Type	Description
`event`	object	Updated event details
↳ `id`	string	Event ID
↳ `name`	string	Event name
↳ `startAt`	string	Event start time (ISO 8601)
↳ `endAt`	string	Event end time (ISO 8601)
↳ `timezone`	string	Event timezone (IANA)
↳ `durationInterval`	string	Event duration (ISO 8601 interval, e.g. PT2H)
↳ `createdAt`	string	Event creation timestamp (ISO 8601)
↳ `description`	string	Event description (plain text)
↳ `descriptionMd`	string	Event description (Markdown)
↳ `coverUrl`	string	Event cover image URL
↳ `url`	string	Event page URL on lu.ma
↳ `visibility`	string	Event visibility (public, members-only, private)
↳ `meetingUrl`	string	Virtual meeting URL
↳ `geoAddressJson`	json	Structured location/address data
↳ `geoLatitude`	string	Venue latitude coordinate
↳ `geoLongitude`	string	Venue longitude coordinate
↳ `calendarId`	string	Associated calendar ID
`hosts`	array	Event hosts
↳ `id`	string	Host ID
↳ `name`	string	Host display name
↳ `firstName`	string	Host first name
↳ `lastName`	string	Host last name
↳ `email`	string	Host email address
↳ `avatarUrl`	string	Host avatar image URL

`luma_list_events`

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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`after`	string	Non	Return events after this ISO 8601 datetime (e.g., 2025-01-01T00:00:00Z)
`before`	string	Non	Return events before this ISO 8601 datetime (e.g., 2025-12-31T23:59:59Z)
`paginationLimit`	number	Non	Maximum number of events to return per page
`paginationCursor`	string	Non	Pagination cursor from a previous response (next_cursor) to fetch the next page of results
`sortColumn`	string	Non	Column to sort by (only start_at is supported)
`sortDirection`	string	Non	Sort direction: asc, desc, asc nulls last, or desc nulls last

Sortie

Paramètre	Type	Description
`events`	array	List of calendar events
↳ `id`	string	Event ID
↳ `name`	string	Event name
↳ `startAt`	string	Event start time (ISO 8601)
↳ `endAt`	string	Event end time (ISO 8601)
↳ `timezone`	string	Event timezone (IANA)
↳ `durationInterval`	string	Event duration (ISO 8601 interval, e.g. PT2H)
↳ `createdAt`	string	Event creation timestamp (ISO 8601)
↳ `description`	string	Event description (plain text)
↳ `descriptionMd`	string	Event description (Markdown)
↳ `coverUrl`	string	Event cover image URL
↳ `url`	string	Event page URL on lu.ma
↳ `visibility`	string	Event visibility (public, members-only, private)
↳ `meetingUrl`	string	Virtual meeting URL
↳ `geoAddressJson`	json	Structured location/address data
↳ `geoLatitude`	string	Venue latitude coordinate
↳ `geoLongitude`	string	Venue longitude coordinate
↳ `calendarId`	string	Associated calendar ID
`hasMore`	boolean	Whether more results are available for pagination
`nextCursor`	string	Cursor 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.

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`url`	string	Non	Public event URL on lu.ma (provide this or an event ID)
`eventId`	string	Non	Event ID to look up (starts with evt-). Provide this or a URL.
`platform`	string	Non	Event platform to look up: luma or external (defaults to luma)

Sortie

Paramètre	Type	Description
`found`	boolean	Whether a matching event was found
`eventId`	string	Resolved event ID
`apiId`	string	Resolved event API ID (deprecated identifier)
`status`	string	Event 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.

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Oui	Event ID to cancel (starts with evt-)
`cancellationToken`	string	Oui	Cancellation token from the Request Event Cancellation endpoint (POST /v1/event/cancel/request)
`shouldRefund`	boolean	Non	Whether to refund paid guests. Required if the event has paid registrations.

Sortie

Paramètre	Type	Description
`cancelled`	boolean	Whether 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.

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Oui	Event ID (starts with evt-)
`approvalStatus`	string	Non	Filter by approval status: approved, session, pending_approval, invited, declined, or waitlist
`paginationLimit`	number	Non	Maximum number of guests to return per page
`paginationCursor`	string	Non	Pagination cursor from a previous response (next_cursor) to fetch the next page of results
`sortColumn`	string	Non	Column to sort by: name, email, created_at, registered_at, or checked_in_at
`sortDirection`	string	Non	Sort direction: asc, desc, asc nulls last, or desc nulls last

Sortie

Paramètre	Type	Description
`guests`	array	List of event guests
↳ `id`	string	Guest ID
↳ `email`	string	Guest email address
↳ `name`	string	Guest full name
↳ `firstName`	string	Guest first name
↳ `lastName`	string	Guest last name
↳ `approvalStatus`	string	Guest approval status (approved, session, pending_approval, invited, declined, waitlist)
↳ `registeredAt`	string	Registration timestamp (ISO 8601)
↳ `invitedAt`	string	Invitation timestamp (ISO 8601)
↳ `joinedAt`	string	Join timestamp (ISO 8601)
↳ `checkedInAt`	string	Check-in timestamp (ISO 8601)
↳ `phoneNumber`	string	Guest phone number
`hasMore`	boolean	Whether more results are available for pagination
`nextCursor`	string	Cursor to pass as paginationCursor to fetch the next page

`luma_get_guest`

Retrieve a single guest

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Oui	Event ID the guest belongs to (starts with evt-)
`guestIdentifier`	string	Oui	Guest ID (gst-...), guest key (g-...), ticket key, or the guest's email address

Sortie

Paramètre	Type	Description
`guest`	object	Guest details
↳ `id`	string	Guest ID
↳ `email`	string	Guest email address
↳ `name`	string	Guest full name
↳ `firstName`	string	Guest first name
↳ `lastName`	string	Guest last name
↳ `approvalStatus`	string	Guest approval status (approved, session, pending_approval, invited, declined, waitlist)
↳ `registeredAt`	string	Registration timestamp (ISO 8601)
↳ `invitedAt`	string	Invitation timestamp (ISO 8601)
↳ `joinedAt`	string	Join timestamp (ISO 8601)
↳ `checkedInAt`	string	Check-in timestamp (ISO 8601)
↳ `phoneNumber`	string	Guest 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.

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Oui	Event ID (starts with evt-)
`guests`	string	Oui	JSON 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"}]

Sortie

Paramètre	Type	Description
`guests`	array	List of added guests with their assigned status and ticket info
↳ `id`	string	Guest ID
↳ `email`	string	Guest email address
↳ `name`	string	Guest full name
↳ `firstName`	string	Guest first name
↳ `lastName`	string	Guest last name
↳ `approvalStatus`	string	Guest approval status (approved, session, pending_approval, invited, declined, waitlist)
↳ `registeredAt`	string	Registration timestamp (ISO 8601)
↳ `invitedAt`	string	Invitation timestamp (ISO 8601)
↳ `joinedAt`	string	Join timestamp (ISO 8601)
↳ `checkedInAt`	string	Check-in timestamp (ISO 8601)
↳ `phoneNumber`	string	Guest phone number

`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.

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Oui	Event ID to invite guests to (starts with evt-)
`guests`	string	Oui	JSON array of guest objects. Each guest requires an "email" field and optionally "name". Example: [{"email": "user@example.com", "name": "John Doe"}]
`message`	string	Non	Optional custom message included in the invite email (max 200 characters)

Sortie

Paramètre	Type	Description
`invited`	number	Number of guests invited to the event

`luma_update_guest_status`

Update a guest

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Luma API key
`eventId`	string	Non	Event ID the guest belongs to (starts with evt-)
`guestIdentifier`	string	Oui	Guest email address or guest ID (gst-...). Values containing '@' are treated as emails; otherwise as a guest ID.
`status`	string	Oui	New approval status: approved, declined, pending_approval, or waitlist
`shouldRefund`	boolean	Non	Refund a paid guest when moving them out of an approved state (defaults to false)
`sendEmail`	boolean	Non	Whether to email the guest about the status change (defaults to true)

Sortie

Paramètre	Type	Description
`status`	string	The approval status applied to the guest
`guest`	string	The guest identifier (email or ID) that was updated

On this page