Luma API
Tools that enable LLMs to interact directly with the Luma API.
1.0.0LumaApi provides tools that facilitate LLMs in interacting seamlessly with the Luma API to manage events and user memberships. This toolkit allows developers to efficiently handle event creation, guest management, and membership features.
Capabilities
- Create, update, and manage events and their details.
- Add and update guests, hosts, and members for events.
- Generate and manage event tickets and coupons.
- Import people and apply tags to streamline calendar management.
OAuth
- No OAuth configurations required; utilize API key for access.
Secrets
- Secret Type: API Key
- Example: LUMA_API_KEY (used for authenticating API requests).
Available tools(37)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add guests to an event with default or custom tickets.
Add guests to an event with the status "Going." By default, each guest receives one ticket of the default type. Specify custom ticket assignments if needed.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Add a host to an event in Luma.
Use this tool to add a host to an event in Luma. If the host already has a Luma profile, it will automatically be recognized and added.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Add an existing event to the Luma calendar.
Use this tool to add an existing event from Luma or another platform to the Luma calendar without managing it there. Useful for integrating events across platforms.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Add a user to a specified free membership tier.
This tool adds a user to a free membership tier. It should be called whenever there is a need to enroll a user in a free membership program. Note that paid membership tiers are not supported by this tool, as they require a web payment flow.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Apply a tag to existing calendar members.
Use this tool to assign a specific tag to already existing members of a calendar. It does not create new members but merely updates the tagging for current members. | 1 | ||
Determine if an event exists on the calendar.
Use this tool to find out if an event is already listed on the calendar before deciding to add it. | 1 | ||
Creates and schedules a new event.
This tool allows users to create and schedule a new event using the Luma service. Call this tool when you need to set up a new event with specific details.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a non-editable coupon for event registration.
Use this tool to create a coupon for guests registering for an event. Once created, the terms of the coupon cannot be edited.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new ticket type for an event.
Use this tool to create a new ticket type for an event. Call this when you need to specify different ticket categories for an event.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Create a new person tag in the calendar system.
This tool is used to create a new person tag within the calendar system, allowing for the organization and tagging of individuals.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Deletes a person tag from the calendar.
Use this tool to delete a person tag from a calendar entry when modifications are needed. It confirms the successful removal of the tag. | 1 | ||
Create a coupon for calendar-managed events.
This tool generates a coupon applicable to any event managed by the calendar. Ensure the coupon code is unique to avoid conflicts between specific events and the calendar.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Generates a URL for image upload.
Use this tool to generate a URL where images can be uploaded. This is useful when you need to upload images to the Luma service.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Retrieve admin information for an accessible event.
This tool is used to get administrative details about an event for which the user has management access. It should be called when detailed event information is required by an admin. | 1 | ||
Retrieve event guest details using their ID.
Use this tool to get details of an event guest by specifying their ID. It facilitates looking up guests through various parameters. | 1 | ||
Retrieve registered or invited guests for an event.
Use this tool to obtain a list of guests who have registered or been invited to a specific event. | 1 | ||
Retrieve event ticket type details by ID.
Use this tool to get detailed information about a specific ticket type by providing its ID. Ideal for fetching ticket-related details for events. | 1 | ||
Retrieve the user's personal information and profile details.
This tool is used to fetch the current user's personal details, including profile information. It can be called when an application needs to access the user's data for personalization or account management purposes. | 1 | ||
Import people to your calendar from contact lists.
This tool is used to import individuals from contact lists into your calendar, making it simple to invite them to events and send newsletters. Use this when you need to manage and communicate with attendees efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Retrieve all coupons for a calendar.
Use this tool to obtain a comprehensive list of all coupons that have been created for a specific calendar. | 1 | ||
Retrieve all coupons created for an event.
Use this tool to obtain a list of all coupons that have been generated for a specific event. This tool is useful for managing and analyzing promotional strategies linked to events. | 1 | ||
Retrieve a list of all ticket types for an event.
Use this tool to get a detailed list of available ticket types for a specific event. It is useful for understanding ticket options and pricing for attendees. | 1 | ||
Retrieve all events managed by your Luma Calendar.
Use this tool to list all events managed by your Luma Calendar. It does not include events that are listed but not managed by the Calendar. | 1 | ||
Retrieve available membership tiers for the calendar. | 1 | ||
Retrieve a list of people from the calendar.
Use this tool to obtain a list of people associated with the calendar. | 1 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
LumaApi.AddEventGuests
Add guests to an event with default or custom tickets. Add guests to an event with the status "Going." By default, each guest receives one ticket of the default type. Specify custom ticket assignments if needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.AddEventHost
Add a host to an event in Luma. Use this tool to add a host to an event in Luma. If the host already has a Luma profile, it will automatically be recognized and added. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.AddEventToLumaCalendar
Add an existing event to the Luma calendar. Use this tool to add an existing event from Luma or another platform to the Luma calendar without managing it there. Useful for integrating events across platforms. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.AddUserToMembershipTier
Add a user to a specified free membership tier. This tool adds a user to a free membership tier. It should be called whenever there is a need to enroll a user in a free membership program. Note that paid membership tiers are not supported by this tool, as they require a web payment flow. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ApplyTagToCalendarMembers
Apply a tag to existing calendar members. Use this tool to assign a specific tag to already existing members of a calendar. It does not create new members but merely updates the tagging for current members.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tag_identifier | string | Required | The Tag API ID (e.g., 'tag-123') or tag name to be applied to calendar members. |
email_addresses | array<string> | Optional | Array of email addresses to apply the tag to existing calendar members. |
user_api_ids_to_tag | array<string> | Optional | Array of user API IDs to apply the tag to. Each ID corresponds to a calendar member. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.CheckEventExistence
Determine if an event exists on the calendar. Use this tool to find out if an event is already listed on the calendar before deciding to add it.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
calendar_platform_type | string | Optional | Specifies the source platform of the event, either 'external' or 'luma'. |
event_details_url | string | Optional | The URL of the event page to check if it exists in the calendar. |
event_identifier | string | Optional | A unique string identifier for the event to check its existence on the calendar. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.CreateEvent
Creates and schedules a new event. This tool allows users to create and schedule a new event using the Luma service. Call this tool when you need to set up a new event with specific details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.CreateEventCoupon
Create a non-editable coupon for event registration. Use this tool to create a coupon for guests registering for an event. Once created, the terms of the coupon cannot be edited. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.CreateEventTicketType
Create a new ticket type for an event. Use this tool to create a new ticket type for an event. Call this when you need to specify different ticket categories for an event. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.CreatePersonTag
Create a new person tag in the calendar system. This tool is used to create a new person tag within the calendar system, allowing for the organization and tagging of individuals. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.DeletePersonTag
Deletes a person tag from the calendar. Use this tool to delete a person tag from a calendar entry when modifications are needed. It confirms the successful removal of the tag.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tag_identifier | string | Required | The unique identifier of the person tag to be deleted. It should match the tag's API ID. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.GenerateEventCoupon
Create a coupon for calendar-managed events. This tool generates a coupon applicable to any event managed by the calendar. Ensure the coupon code is unique to avoid conflicts between specific events and the calendar. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.GenerateUploadUrl
Generates a URL for image upload. Use this tool to generate a URL where images can be uploaded. This is useful when you need to upload images to the Luma service. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.GetEventAdminInfo
Retrieve admin information for an accessible event. This tool is used to get administrative details about an event for which the user has management access. It should be called when detailed event information is required by an admin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_api_id | string | Optional | Event API ID, starting with 'evt-', used to identify the event. |
event_id | string | Optional | The unique identifier for the event, usually starts with 'evt-'. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.GetEventGuest
Retrieve event guest details using their ID. Use this tool to get details of an event guest by specifying their ID. It facilitates looking up guests through various parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_api_id | string | Optional | Provide the unique API ID for the event to retrieve guest details. |
event_identifier | string | Optional | The ID of the event, typically starting with 'evt-'. Used to identify the specific event. |
guest_api_id | string | Optional | The unique API ID of the guest, distinct from the user ID. This is used for identifying the guest within the system. |
guest_email | string | Optional | The email address of the event guest to look up. |
guest_identifier | string | Optional | Identifier for looking up the guest, such as guest ID (gst-), ticket key, guest key (g-), or the user's email. |
proxy_key | string | Optional | Value of the `pk` parameter from the check-in QR code used to identify the guest. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.GetEventGuests
Retrieve registered or invited guests for an event. Use this tool to obtain a list of guests who have registered or been invited to a specific event.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_api_id | string | Optional | The unique ID of the event, typically starting with 'evt-'. |
event_id | string | Optional | The unique identifier for the event, usually starts with 'evt-'. |
guest_approval_status | string | Optional | Filter guests by their approval status. Options: 'approved', 'session', 'pending_approval', 'invited', 'declined', 'waitlist'. |
guest_sort_column | string | Optional | The column to sort the guest list by. Options are 'name', 'email', 'created_at', 'registered_at', or 'checked_in_at'. |
items_to_return | number | Optional | Specify the number of guest entries to return. The server enforces a maximum limit. |
next_cursor_value | string | Optional | Value of `next_cursor` from a previous request to paginate through results. |
sort_order | string | Optional | Specify the order for sorting the list of guests. Acceptable values are 'asc', 'desc', 'asc nulls last', or 'desc nulls last'. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.GetTicketTypeById
Retrieve event ticket type details by ID. Use this tool to get detailed information about a specific ticket type by providing its ID. Ideal for fetching ticket-related details for events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_ticket_type_api_id | string | Optional | The unique API ID for the event ticket type. It must be provided to retrieve ticket information. |
ticket_type_id | string | Optional | The ID of the ticket type to retrieve, typically starts with 'ett-'. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.GetUserInfo
Retrieve the user's personal information and profile details. This tool is used to fetch the current user's personal details, including profile information. It can be called when an application needs to access the user's data for personalization or account management purposes.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ImportPeopleToCalendar
Import people to your calendar from contact lists. This tool is used to import individuals from contact lists into your calendar, making it simple to invite them to events and send newsletters. Use this when you need to manage and communicate with attendees efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ListCalendarCoupons
Retrieve all coupons for a calendar. Use this tool to obtain a comprehensive list of all coupons that have been created for a specific calendar.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
items_to_return | number | Optional | The number of coupon items to retrieve. The server enforces a maximum limit. |
pagination_cursor | string | Optional | Provide the `next_cursor` value obtained from a prior request to paginate through results. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ListEventCoupons
Retrieve all coupons created for an event. Use this tool to obtain a list of all coupons that have been generated for a specific event. This tool is useful for managing and analyzing promotional strategies linked to events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_api_id | string | Optional | The unique identifier for the event, typically starting with 'evt-'. Required to list coupons for the specified event. |
event_identifier | string | Optional | Event ID, typically starting with 'evt-'. It identifies the specific event for which to list coupons. |
item_return_limit | number | Optional | Specifies the number of items to return in the response, up to the server's maximum allowed. |
pagination_cursor | string | Optional | Value of `next_cursor` from a previous request to continue pagination. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ListEventTicketTypes
Retrieve a list of all ticket types for an event. Use this tool to get a detailed list of available ticket types for a specific event. It is useful for understanding ticket options and pricing for attendees.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_id | string | Optional | The unique identifier for an event, typically starting with 'evt-'. |
event_identifier | string | Optional | The unique identifier for the event, usually starting with evt-. |
include_hidden_ticket_types | string | Optional | Set to true to include hidden ticket types in the response list. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ListLumaCalendarEvents
Retrieve all events managed by your Luma Calendar. Use this tool to list all events managed by your Luma Calendar. It does not include events that are listed but not managed by the Calendar.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_sort_direction | string | Optional | Defines the order of events. Use 'asc' or 'desc' for ascending or descending. Options 'asc nulls last' and 'desc nulls last' place nulls at the end. |
filter_events_before | string | Optional | Filter events to show only those happening before this ISO 8601 Datetime. Example: 2022-10-19T03:27:13.673Z |
number_of_items_to_return | number | Optional | The number of events to return. The server enforces a maximum limit. |
pagination_cursor | string | Optional | Use the `next_cursor` value from a previous request to continue listing events. |
sort_by_column | string | Optional | Specify the column to sort events by. For now, 'start_at' is the available option. |
start_date_after | string | Optional | Specify the starting datetime to filter events after this timestamp in ISO 8601 format (e.g., 2022-10-19T03:27:13.673Z). |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ListMembershipTiers
Retrieve available membership tiers for the calendar.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
items_to_return_count | number | Optional | Specify the number of membership tiers to return. The server may enforce a maximum limit. |
previous_request_next_cursor | string | Optional | The `next_cursor` value from a prior request for fetching subsequent data. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ListPeople
Retrieve a list of people from the calendar. Use this tool to obtain a list of people associated with the calendar.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
calendar_membership_status | string | Optional | Specify the membership status for filtering calendar members. This is only relevant for calendar memberships. |
calendar_membership_tier_api_id | string | Optional | A unique identifier for the calendar membership tier to filter people. |
calendar_tier_id | string | Optional | Unique identifier for the calendar membership tier to filter people. |
filter_by_tags | string | Optional | Comma-separated list of tag names or IDs to filter people with specified tags. |
items_to_return | number | Optional | Specify the number of items to return in the response. The server may enforce a maximum limit. |
pagination_next_cursor | string | Optional | Provide the `next_cursor` value from a previous request to continue pagination. |
search_query | string | Optional | Search for people using names or emails. |
sort_by_column | string | Optional | Sort the list of people by a specified column: created_at, event_checked_in_count, event_approved_count, name, or revenue_usd_cents. |
sort_order | string | Optional | Specifies the order for sorting results: 'asc', 'desc', 'asc nulls last', or 'desc nulls last'. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ListPersonTags
Retrieve a list of tags associated with persons. This tool is used to call the Luma API to get a list of tags that are associated with persons. It should be called when there's a need to retrieve person tags from the Luma service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
items_to_return | number | Optional | Specify the number of tags to return. The server will impose a maximum limit. |
pagination_cursor | string | Optional | Use the `next_cursor` value from a previous response to paginate results. |
sort_by_column | string | Optional | Specifies the column to sort the tags by. Options are 'name', 'color', or 'created_at'. |
sorting_direction | string | Optional | Specifies the order direction of the person tags. Choose from 'asc', 'desc', 'asc nulls last', or 'desc nulls last'. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.LumaEntityLookup
Lookup an entity on Luma by its slug. Use this tool to fetch detailed information about an entity from Luma using a specific slug identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
entity_slug | string | Required | The unique string identifier for the entity to be looked up in Luma. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.ModifyCoupon
Update a coupon's details in the system. Use this tool to update the details of an existing coupon. It should be called when changes to coupon parameters are needed, such as expiration date or discount value. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.RemoveTagFromCalendarMembers
Remove a tag from existing calendar members. Use this tool to remove a specified tag from existing members of a calendar. Intended for managing and updating member tags efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tag_identifier | string | Required | The ID or name of the tag to remove from calendar members, such as 'tag-123' or 'Birthday'. |
email_addresses_to_remove_tag | array<string> | Optional | Array of email addresses to remove the tag from the calendar members. |
user_api_ids_to_remove_tag | array<string> | Optional | Array of user API IDs from which to remove the specified tag. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.SendGuestEventInvite
Send event invitations to guests via email and SMS. This tool sends an invitation to guests for an event by email and SMS, leveraging the Luma service. It is useful when you need to notify guests about an event quickly and ensure they receive the invitation through multiple channels. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.SoftDeleteTicketType
Soft delete a ticket type if certain conditions are met. Use this tool to soft delete a ticket type, provided no tickets have been sold and it's not the last visible type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_ticket_type_id | string | Required | The ID of the event ticket type to be soft deleted. Ensure no tickets are sold, and it's not the last visible type before deletion. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.UpdateCoupon
Updates a coupon in the calendar. Use this tool to modify the details of an existing coupon in the Luma calendar system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.UpdateEvent
Update event details using Luma's API. This tool updates event information using Luma's event update endpoint. It should be called when modifications to event details are required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.UpdateGuestStatus
Updates the status of an event guest. Use this tool to change the status of a guest in an event, such as marking them as confirmed, declined, or pending. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.UpdateMembershipStatus
Update a member's membership status and handle payments. Use this tool to approve or decline a member's membership status. Approving a paid tier member will capture their payment, while declining will cancel any active subscription.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
membership_status | string | Required | Set the membership status to either 'approved' to capture payment or 'declined' to cancel the subscription. |
user_identifier | string | Required | User ID (e.g., 'usr-xxx') or email address to identify the member whose status is to be updated. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.UpdatePersonTag
Updates a tag for a person in the calendar system. This tool is used to update a person's tag within the calendar system. It should be called when there is a need to change or assign a new label to a person in a calendar context.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
person_tag_api_id | string | Required | The unique identifier for the tag to be updated. It is required to identify which tag needs modification. |
tag_color | string | Optional | Specify the color to be assigned to the person's tag. Choose from: cranberry, barney, red, green, blue, purple, yellow, orange. |
tag_name | string | Optional | The new name for the tag to be updated. It should be descriptive and relevant to the person's role or status. |
Requirements
Output
json— Response from the API endpoint ''.LumaApi.UpdateTicketTypeConfiguration
Update an existing ticket type configuration. Use this tool to modify the settings of a ticket type for an event. It should be called when changes to a ticket type's details or availability are required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint ''.