Eventbrite — Printing Press CLI
Prerequisites: Install the CLI
This skill drives the eventbrite-pp-cli binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
- Install via the Printing Press installer. It defaults binaries to
$HOME/.local/bin on macOS/Linux and %LOCALAPPDATA%\Programs\PrintingPress\bin on Windows:npx -y @mvanhorn/printing-press-library install eventbrite --cli-only
- Verify:
eventbrite-pp-cli --version
- Ensure the reported install directory is on
$PATH for the agent/runtime that will invoke this skill.
If the npx install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer):
go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/eventbrite/cmd/eventbrite-pp-cli@latest
If --version reports "command not found" after install, the runtime cannot see the binary directory on $PATH. Do not proceed with skill commands until verification succeeds.
When to Use This CLI
Use this CLI when an agent manages an organizer's Eventbrite presence: creating and publishing events, pulling order and attendee history, and answering cross-event questions (which events sell slowest, which fans return, who the top buyers are, how a discount code performed) that the per-event dashboard and existing single-org MCP servers cannot answer. It is the right tool whenever the task needs the whole order/attendee history in one place rather than a single live API lookup. When the same promoter also sells on DICE, both CLIs emit JSON and a local SQLite store, so an agent can join the two datasets by event (name and date) and by buyer email for a cross-platform performance and loyalty picture.
Unique Capabilities
These capabilities aren't available in any other tool for this API.
Cross-event sales analytics
sales-velocity — Ranks all your live events by tickets sold per day since on-sale and projects a sell-out date.
Reach for this when an agent needs to know which of an organizer's events are underperforming right now, not just current totals.
eventbrite-pp-cli sales-velocity --json
discount-performance — Per discount code: redemptions, type, and the redemption rate (share of the code's allotment used).
Pick this to measure whether a promo code actually drove sales before renewing or killing it.
eventbrite-pp-cli discount-performance --json
capacity — Sold vs total capacity and percent remaining across all your live events at once.
Use this to spot which events are near sell-out or badly under-sold in a single call.
eventbrite-pp-cli capacity --json
refund-rate — Refunded and cancelled order counts, refunded revenue, and the rate per event or across the org.
Pick this to flag events with abnormal refund rates that signal a pricing, date, or fulfillment problem.
eventbrite-pp-cli refund-rate --json
top-buyers — Ranks ticket buyers by total spend across all your events, not just by how many events they attended.
Reach for this to find an organizer's highest-value customers for VIP or pre-sale outreach.
eventbrite-pp-cli top-buyers --limit 25 --json
Search your own data offline
repeat-attendees — Finds fans who bought into two or more of your events, across your whole synced history.
Use this for loyalty and re-marketing questions an agent cannot answer from any one event's attendee list.
eventbrite-pp-cli repeat-attendees --min 2 --json
roster — Offline attendee roster for one event with checked-in vs not-yet, VIP and comp flags, door-sorted.
Reach for this at the door when an agent needs a fast who-has-not-checked-in list without a live API round-trip.
eventbrite-pp-cli roster 1234567890 --csv
fan-export — Exports unique attendee contacts (email, name, events attended, check-in status), deduped across all your events and filterable by event.
Use this to build a clean, deduped contact list for an email campaign across an organizer's whole audience.
eventbrite-pp-cli fan-export --csv
Agency multi-org view
org-rollup — Single pane across every organization your token can see: events count, tickets sold, gross, and top event per org.
Use this for an agency or multi-brand operator who needs one client roll-up instead of logging into each org.
eventbrite-pp-cli org-rollup --json
Command Reference
balance — Manage balance
categories —
Category Object
An overarching category that an event falls into (vertical). Examples are “Music”, and “Endurance”.
eventbrite-pp-cli categories category-by-id — Gets a category by ID as category.
eventbrite-pp-cli categories list-of — Returns a list of Category as categories, including subcategories nested. Returns a paginated response.
discounts —
Discount Object
The Discount object represents a discount that an Order owner can use when purchasing tickets to an Event.
A Discount can be used to a single Ticket Class or across multiple Ticket Classes for multiple Events simultaneously (known as a cross event Discount).
There are four types of Discounts:
Public Discount. Publically displays Discount to Order owner on the Event Listing and Checkout pages. Only used with a single Event.
Coded Discount. Requires Order owner to use a secret code to access the Discount.
Access Code. Requires Order owner to use a secret code to access hidden tickets. Access codes can also optionally contain a discount amount.
Hold Discount. Allows Order owner to apply or unlock Discount for seats on hold.
The display price of a ticket is calculated as:
price_before_discount - discount_amount = display_price
Notes:
Public and Coded Discounts can specify either an amount off or a percentage off, but not both types discounts.
Public Discounts should not contain apostrophes or non-alphanumeric characters (except “-���, “_”, ” ”, “(”, ”)”, “/”, and “”).
Coded Discounts and Access Codes should not contain spaces, apostrophes or non-alphanumeric characters (except “-”, “_”, “(”, ”)”, “/”, and “”).
Fields
Use these fields to specify information about a Discount.
| Field |
Type |
Description |
code |
string |
Discount name for a Public Discount, or the code for a Coded Discount and Access Code. |
type |
string |
Discount type. Can be access, coded, public or hold. |
end_date |
datetime |
Date until which the Discount code is usable. Date is naive and assumed relative to the timezone of an Event. If null or empty, the discount is usable until the Event end_date. ISO 8601 notation: YYYY-MM-DDThh:mm:ss. |
end_date_relative |
integer |
End time in seconds before the start of the Event until which the Discount code is usable. If null or empty, the discount is usable until the Event end_date. |
amount_off |
decimal |
Fixed amount applied as a Discount. This amount is not expressed with a currency; instead uses the Event currency from 0.01 to 99999.99. Only two decimals are allowed. The default is null for an Access Code. |
percent_off |
decimal |
Percentage amount applied as a Discount. Displayed in the ticket price during checkout, from 1.00 to 100.00. Only two decimals are allowed. The default is null for an Access Code. |
quantity_available |
integer |
Number of times this Discount can be used; 0 indicates unlimited use. |
quantity_sold |
integer |
Number of times this Discount has been used. This is a read only field. |
start_date |
local datetime |
Date from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
start_date_relative |
integer |
Start time in seconds before the start of the Event from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
ticket_class_ids |
list |
List of discounted Ticket Class IDs for a single Event. Leave empty if you want to see all the tickets for the Event. |
event_id |
string |
Single Event ID to which the Discount can be used. Leave empty for Discounts. |
ticket_group_id |
string |
Ticket Group ID to which the Discount can be used. |
hold_ids |
list |
List of hold IDs this discount can unlock. Null if this discount does not unlock a hold. |
The following conditions define the extend of the Discount:
If event_id is provided and ticket_class_ids are not provided, a single Event Discount is created for all Event tickets.
If both event_id and ticket_class_ids are provided, a single Event Discount is created for the specific Event tickets.
If ticket_group_id is provided, a Discount is created for the Ticket Group.
If neither event_id nor ticket_group_id are provided, a Discount is created that applies to all tickets for an Organization's Events, including future Events.
Expansions
Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
| Expansion |
Source |
Description |
event |
event_id |
Single Event to which the Discount can be used. |
ticket_group |
ticket_group_id |
Ticket Group to which the Discount can be used. |
reserved_seating |
ticket-reserved-seating-settings |
Reserved seating settings for the Ticket Class. This expansion is not returned for Ticket Classes that do not support reserved seasting. |
eventbrite-pp-cli discounts delete-a — Delete a Discount. Only unused Discounts can be deleted.
eventbrite-pp-cli discounts retrieve-a — Retrieve a Discount by Discount ID.
eventbrite-pp-cli discounts update-a — Update a Discount by Discount ID.
event —
Event Object
The Event object represents an Eventbrite Event. An Event is owned by one Organization.
Public Fields
Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite Users and Eventbrite applications.
| Field |
Type |
Description |
name |
multipart-text |
Event name. |
summary |
string |
(Optional) Event summary. Short summary describing the event and its purpose. |
description |
multipart-text |
(DEPRECATED) (Optional) Event description. Description can be lengthy and have significant formatting. |
url |
string |
URL of the Event's Listing page on eventbrite.com. |
start |
datetime-tz |
Event start date and time. |
end |
datetime-tz |
Event end date and time. |
created |
datetime |
Event creation date and time. |
changed |
datetime |
Date and time of most recent changes to the Event. |
published |
datetime |
Event publication date and time. |
status |
string |
Event status. Can be draft, live, started, ended, completed and canceled. |
currency |
string |
Event ISO 4217 currency code. |
online_event |
boolean |
true = Specifies that the Event is online only (i.e. the Event does not have a Venue). |
hide_start_date |
boolean |
If true, the event's start date should never be displayed to attendees. |
hide_end_date |
boolean |
If true, the event's end date should never be displayed to attendees. |
Private Fields
Use these fields to specify properties of an Event that are only available to the User.
| Field |
Type |
Description |
listed |
boolean |
true = Allows the Event to be publicly searchable on the Eventbrite website. |
shareable |
boolean |
true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
invite_only |
boolean |
true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
show_remaining |
boolean |
true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
password |
string |
Event password used by visitors to access the details of the Event. |
capacity |
integer |
Maximum number of tickets for the Event that can be sold to Attendees. The total capacity is calculated by the sum of the quantity_total of the Ticket Class. |
capacity_is_custom |
boolean |
true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
Music Properties
The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the music_properties expansion.
| Field |
Type |
Description |
age_restriction |
enum |
Minimum age requirement of event attendees. |
presented_by |
string |
Main music event sponsor. |
door_time |
string |
Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
Expansions
Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
| Expansion |
Source |
Description |
logo |
logo_id |
Event image logo. |
venue |
venue_id |
Event Venue. |
organizer |
organizer_id |
Event Organizer. |
format |
format_id |
Event Format. |
category |
category_id |
Event Category. |
subcategory |
subcategory_id |
Event Subcategory. |
bookmark_info |
bookmark_info |
Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like {count:3}. |
refund_policy |
refund_policy |
Event Refund Policy. |
ticket_availability |
ticket_availability |
Overview of availability of all Ticket Classes |
external_ticketing |
external_ticketing |
External ticketing data for the Event. |
music_properties |
music_properties |
Event Music Properties |
publish_settings |
publish_settings |
Event publish settings. |
basic_inventory_info |
basic_inventory_info |
Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
event_sales_status |
event_sales_status |
Event’s sales status details |
checkout_settings |
checkout_settings |
Event checkout and payment settings. |
listing_properties |
listing_properties |
Display/listing details about the event |
has_digital_content |
has_digital_content |
Whether or not an event Has Digital Content |
events —
Event Object
The Event object represents an Eventbrite Event. An Event is owned by one Organization.
Public Fields
Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite Users and Eventbrite applications.
| Field |
Type |
Description |
name |
multipart-text |
Event name. |
summary |
string |
(Optional) Event summary. Short summary describing the event and its purpose. |
description |
multipart-text |
(DEPRECATED) (Optional) Event description. Description can be lengthy and have significant formatting. |
url |
string |
URL of the Event's Listing page on eventbrite.com. |
start |
datetime-tz |
Event start date and time. |
end |
datetime-tz |
Event end date and time. |
created |
datetime |
Event creation date and time. |
changed |
datetime |
Date and time of most recent changes to the Event. |
published |
datetime |
Event publication date and time. |
status |
string |
Event status. Can be draft, live, started, ended, completed and canceled. |
currency |
string |
Event ISO 4217 currency code. |
online_event |
boolean |
true = Specifies that the Event is online only (i.e. the Event does not have a Venue). |
hide_start_date |
boolean |
If true, the event's start date should never be displayed to attendees. |
hide_end_date |
boolean |
If true, the event's end date should never be displayed to attendees. |
Private Fields
Use these fields to specify properties of an Event that are only available to the User.
| Field |
Type |
Description |
listed |
boolean |
true = Allows the Event to be publicly searchable on the Eventbrite website. |
shareable |
boolean |
true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
invite_only |
boolean |
true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
show_remaining |
boolean |
true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
password |
string |
Event password used by visitors to access the details of the Event. |
capacity |
integer |
Maximum number of tickets for the Event that can be sold to Attendees. The total capacity is calculated by the sum of the quantity_total of the Ticket Class. |
capacity_is_custom |
boolean |
true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
Music Properties
The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the music_properties expansion.
| Field |
Type |
Description |
age_restriction |
enum |
Minimum age requirement of event attendees. |
presented_by |
string |
Main music event sponsor. |
door_time |
string |
Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
Expansions
Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
| Expansion |
Source |
Description |
logo |
logo_id |
Event image logo. |
venue |
venue_id |
Event Venue. |
organizer |
organizer_id |
Event Organizer. |
format |
format_id |
Event Format. |
category |
category_id |
Event Category. |
subcategory |
subcategory_id |
Event Subcategory. |
bookmark_info |
bookmark_info |
Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like {count:3}. |
refund_policy |
refund_policy |
Event Refund Policy. |
ticket_availability |
ticket_availability |
Overview of availability of all Ticket Classes |
external_ticketing |
external_ticketing |
External ticketing data for the Event. |
music_properties |
music_properties |
Event Music Properties |
publish_settings |
publish_settings |
Event publish settings. |
basic_inventory_info |
basic_inventory_info |
Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
event_sales_status |
event_sales_status |
Event’s sales status details |
checkout_settings |
checkout_settings |
Event checkout and payment settings. |
listing_properties |
listing_properties |
Display/listing details about the event |
has_digital_content |
has_digital_content |
Whether or not an event Has Digital Content |
eventbrite-pp-cli events delete-an — Delete an Event if the delete is permitted. Returns a boolean indicating the success or failure of the delete action.
eventbrite-pp-cli events retrieve-an — Retrieve an Event by Event ID.
eventbrite-pp-cli events update-an — Update Event by Event ID.
formats —
Format Object
The Format object represents an Event type, for example seminar, workshop or concert. Specifying a Format helps website visitors discover a certain type of Event.
eventbrite-pp-cli formats list — List all available Formats. Returns a paginated response.
eventbrite-pp-cli formats retrieve-a — Retrieve a Format by Format ID.
media —
Media Object
The Media object represents an image that can be included with an Event listing, for example to provide branding or further information on the Event.
eventbrite-pp-cli media retrieve — Retrieve Media by Media ID.
eventbrite-pp-cli media retrieve-a-upload — Retrieve information on a Media image upload.
eventbrite-pp-cli media upload-a-file — Upload a Media image file.
orders —
Order object
The Order object represents an order made against Eventbrite for one or more Ticket Classes. In other words, a single Order can be made up of multiple tickets. The object contains an Order's financial and transactional information; use the Attendee object to return information on Attendees.
Order objects are considered private; meaning that all Order information is only available to the Eventbrite User and Order owner.
Order Fields
| Field |
Type |
Description |
created |
datetime |
Date and time the Order was placed and the Attendee created. |
…(truncated)
1---
2name: pp-eventbrite
3description: "Every Eventbrite organizer endpoint, plus a local SQLite mirror of your events, orders Trigger phrases: `sync my eventbrite events`, `which of my events are selling slowest`, `find repeat attendees on eventbrite`, `check in roster for my event`, `how did my discount code perform`, `use eventbrite`, `run eventbrite`."
4author: "Vinny Pasceri"
5license: "Apache-2.0"
6argument-hint: "<command> [args] | install cli|mcp"
7allowed-tools: "Read Bash"
8metadata:
9 source: https://skillmd.com/skills/mvanhorn-printing-press-libra/pp-eventbrite
10 openclaw:
11 requires:
12 bins:
13 - eventbrite-pp-cli
14 install:
15 - kind: go
16 bins: [eventbrite-pp-cli]
17 module: github.com/mvanhorn/printing-press-library/library/media-and-entertainment/eventbrite/cmd/eventbrite-pp-cli
18---
19<!-- GENERATED FILE — DO NOT EDIT.
20 This file is a verbatim mirror of library/media-and-entertainment/eventbrite/SKILL.md,
21 regenerated post-merge by tools/generate-skills/. Hand-edits here are
22 silently overwritten on the next regen. Edit the library/ source instead.
23 See the repository agent guide, section "Generated artifacts: registry.json, cli-skills/". -->
24
25# Eventbrite — Printing Press CLI
26
27## Prerequisites: Install the CLI
28
29This skill drives the `eventbrite-pp-cli` binary. **You must verify the CLI is installed before invoking any command from this skill.** If it is missing, install it first:
30
311. Install via the Printing Press installer. It defaults binaries to `$HOME/.local/bin` on macOS/Linux and `%LOCALAPPDATA%\Programs\PrintingPress\bin` on Windows:
32 ```bash
33 npx -y @mvanhorn/printing-press-library install eventbrite --cli-only
34 ```
352. Verify: `eventbrite-pp-cli --version`
363. Ensure the reported install directory is on `$PATH` for the agent/runtime that will invoke this skill.
37
38If the `npx` install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer):
39
40```bash
41go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/eventbrite/cmd/eventbrite-pp-cli@latest
42```
43
44If `--version` reports "command not found" after install, the runtime cannot see the binary directory on `$PATH`. Do not proceed with skill commands until verification succeeds.
45
46## When to Use This CLI
47
48Use this CLI when an agent manages an organizer's Eventbrite presence: creating and publishing events, pulling order and attendee history, and answering cross-event questions (which events sell slowest, which fans return, who the top buyers are, how a discount code performed) that the per-event dashboard and existing single-org MCP servers cannot answer. It is the right tool whenever the task needs the whole order/attendee history in one place rather than a single live API lookup. When the same promoter also sells on DICE, both CLIs emit JSON and a local SQLite store, so an agent can join the two datasets by event (name and date) and by buyer email for a cross-platform performance and loyalty picture.
49
50## Unique Capabilities
51
52These capabilities aren't available in any other tool for this API.
53
54### Cross-event sales analytics
55- **`sales-velocity`** — Ranks all your live events by tickets sold per day since on-sale and projects a sell-out date.
56
57 _Reach for this when an agent needs to know which of an organizer's events are underperforming right now, not just current totals._
58
59 ```bash
60 eventbrite-pp-cli sales-velocity --json
61 ```
62- **`discount-performance`** — Per discount code: redemptions, type, and the redemption rate (share of the code's allotment used).
63
64 _Pick this to measure whether a promo code actually drove sales before renewing or killing it._
65
66 ```bash
67 eventbrite-pp-cli discount-performance --json
68 ```
69- **`capacity`** — Sold vs total capacity and percent remaining across all your live events at once.
70
71 _Use this to spot which events are near sell-out or badly under-sold in a single call._
72
73 ```bash
74 eventbrite-pp-cli capacity --json
75 ```
76- **`refund-rate`** — Refunded and cancelled order counts, refunded revenue, and the rate per event or across the org.
77
78 _Pick this to flag events with abnormal refund rates that signal a pricing, date, or fulfillment problem._
79
80 ```bash
81 eventbrite-pp-cli refund-rate --json
82 ```
83- **`top-buyers`** — Ranks ticket buyers by total spend across all your events, not just by how many events they attended.
84
85 _Reach for this to find an organizer's highest-value customers for VIP or pre-sale outreach._
86
87 ```bash
88 eventbrite-pp-cli top-buyers --limit 25 --json
89 ```
90
91### Search your own data offline
92- **`repeat-attendees`** — Finds fans who bought into two or more of your events, across your whole synced history.
93
94 _Use this for loyalty and re-marketing questions an agent cannot answer from any one event's attendee list._
95
96 ```bash
97 eventbrite-pp-cli repeat-attendees --min 2 --json
98 ```
99- **`roster`** — Offline attendee roster for one event with checked-in vs not-yet, VIP and comp flags, door-sorted.
100
101 _Reach for this at the door when an agent needs a fast who-has-not-checked-in list without a live API round-trip._
102
103 ```bash
104 eventbrite-pp-cli roster 1234567890 --csv
105 ```
106- **`fan-export`** — Exports unique attendee contacts (email, name, events attended, check-in status), deduped across all your events and filterable by event.
107
108 _Use this to build a clean, deduped contact list for an email campaign across an organizer's whole audience._
109
110 ```bash
111 eventbrite-pp-cli fan-export --csv
112 ```
113
114### Agency multi-org view
115- **`org-rollup`** — Single pane across every organization your token can see: events count, tickets sold, gross, and top event per org.
116
117 _Use this for an agency or multi-brand operator who needs one client roll-up instead of logging into each org._
118
119 ```bash
120 eventbrite-pp-cli org-rollup --json
121 ```
122
123## Command Reference
124
125**balance** — Manage balance
126
127
128**categories** — <a name="categories_object"></a>
129
130## Category Object
131
132An overarching category that an event falls into (vertical). Examples are “Music”, and “Endurance”.
133
134- `eventbrite-pp-cli categories category-by-id` — Gets a `category` by ID as ``category``.
135- `eventbrite-pp-cli categories list-of` — Returns a list of Category as categories, including subcategories nested. Returns a paginated response.
136
137**discounts** — <a name="discount_object"></a>
138
139## Discount Object
140
141The Discount object represents a discount that an Order owner can use when purchasing tickets to an [Event](#event_object).
142
143A Discount can be used to a single [Ticket Class](#ticket_class_object) or across multiple Ticket Classes for multiple Events simultaneously (known as a cross event Discount).
144
145There are four types of Discounts:
146
147+ **Public Discount.** Publically displays Discount to Order owner on the Event Listing and Checkout pages. Only used with a single Event.
148
149+ **Coded Discount.** Requires Order owner to use a secret code to access the Discount.
150
151+ **Access Code.** Requires Order owner to use a secret code to access hidden tickets. Access codes can also optionally contain a discount amount.
152
153+ **Hold Discount.** Allows Order owner to apply or unlock Discount for seats on hold.
154
155The display price of a ticket is calculated as: \
156`price_before_discount` - `discount_amount` = `display_price`
157
158Notes:
159
160* Public and Coded Discounts can specify either an amount off or a percentage off, but not both types discounts.
161
162* Public Discounts should not contain apostrophes or non-alphanumeric characters (except “-���, “_”, ” ”, “(”, ”)”, “/”, and “”).
163
164* Coded Discounts and Access Codes should not contain spaces, apostrophes or non-alphanumeric characters (except “-”, “_”, “(”, ”)”, “/”, and “”).
165
166#### Fields
167
168Use these fields to specify information about a Discount.
169
170| Field | Type | Description |
171| :-------------------- | :--------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
172| `code` | `string` | Discount name for a Public Discount, or the code for a Coded Discount and Access Code. |
173| `type` | `string` | Discount type. Can be `access`, `coded`, `public` or `hold`. |
174| `end_date` | `datetime` | Date until which the Discount code is usable. Date is naive and assumed relative to the timezone of an Event. If null or empty, the discount is usable until the Event end_date. ISO 8601 notation: `YYYY-MM-DDThh:mm:ss`.|
175| `end_date_relative` | `integer` | End time in seconds before the start of the Event until which the Discount code is usable. If null or empty, the discount is usable until the Event end_date. |
176| `amount_off` | `decimal` | Fixed amount applied as a Discount. This amount is not expressed with a currency; instead uses the Event currency from 0.01 to 99999.99. Only two decimals are allowed. The default is `null` for an Access Code. |
177| `percent_off` | `decimal` | Percentage amount applied as a Discount. Displayed in the ticket price during checkout, from 1.00 to 100.00. Only two decimals are allowed. The default is `null` for an Access Code. |
178| `quantity_available` | `integer` | Number of times this Discount can be used; `0` indicates unlimited use. |
179| `quantity_sold` | `integer` | Number of times this Discount has been used. This is a read only field. |
180| `start_date` | `local datetime` | Date from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
181| `start_date_relative` | `integer` | Start time in seconds before the start of the Event from which the Discount code is usable. If null or empty, the Discount is usable effective immediately. |
182| `ticket_class_ids` | `list` | List of discounted Ticket Class IDs for a single Event. Leave empty if you want to see all the tickets for the Event. |
183| `event_id` | `string` | Single Event ID to which the Discount can be used. Leave empty for Discounts. |
184| `ticket_group_id` | `string` | [Ticket Group](#ticket_group_object) ID to which the Discount can be used. |
185| `hold_ids` | `list` | List of hold IDs this discount can unlock. Null if this discount does not unlock a hold. |
186
187The following conditions define the extend of the Discount:
188
189* If `event_id` is provided and `ticket_class_ids` are not provided, a single Event Discount is created for all Event tickets.
190
191* If both `event_id` and `ticket_class_ids` are provided, a single Event Discount is created for the specific Event tickets.
192
193* If `ticket_group_id` is provided, a Discount is created for the Ticket Group.
194
195* If neither `event_id` nor `ticket_group_id` are provided, a Discount is created that applies to all tickets for an [Organization's](#organization_object) Events, including future Events.
196
197#### Expansions
198
199Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
200
201| Expansion | Source | Description |
202| :----------------- | :--------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
203| `event` | `event_id` | Single Event to which the Discount can be used. |
204| `ticket_group` | `ticket_group_id` | Ticket Group to which the Discount can be used. |
205| `reserved_seating` | `ticket-reserved-seating-settings` | Reserved seating settings for the [Ticket Class](#ticket_class_object). This expansion is not returned for Ticket Classes that do not support reserved seasting. |
206
207- `eventbrite-pp-cli discounts delete-a` — Delete a Discount. Only unused Discounts can be deleted.
208- `eventbrite-pp-cli discounts retrieve-a` — Retrieve a Discount by Discount ID.
209- `eventbrite-pp-cli discounts update-a` — Update a Discount by Discount ID.
210
211**event** — <a name="event_object"></a>
212
213## Event Object
214
215The Event object represents an Eventbrite Event. An Event is owned by one [Organization](#organization_object).
216
217#### Public Fields
218
219Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite [Users](#user_object) and Eventbrite applications.
220
221| Field | Type | Description |
222| :---------------- | :--------------- | ------------------------------------------------------------------------------------------------------- |
223| `name` | `multipart-text` | Event name. |
224| `summary` | `string` | (Optional) Event summary. Short summary describing the event and its purpose. |
225| `description` | `multipart-text` | (*DEPRECATED*) (Optional) Event description. Description can be lengthy and have significant formatting. |
226| `url` | `string` | URL of the Event's Listing page on eventbrite.com. |
227| `start` | `datetime-tz` | Event start date and time. |
228| `end` | `datetime-tz` | Event end date and time. |
229| `created` | `datetime` | Event creation date and time. |
230| `changed` | `datetime` | Date and time of most recent changes to the Event. |
231| `published` | `datetime` | Event publication date and time. |
232| `status` | `string` | Event status. Can be `draft`, `live`, `started`, `ended`, `completed` and `canceled`. |
233| `currency` | `string` | Event [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. |
234| `online_event` | `boolean` | true = Specifies that the Event is online only (i.e. the Event does not have a [Venue](#venue_object)). |
235| `hide_start_date` | `boolean` | If true, the event's start date should never be displayed to attendees. |
236| `hide_end_date` | `boolean` | If true, the event's end date should never be displayed to attendees. |
237
238#### Private Fields
239
240Use these fields to specify properties of an Event that are only available to the [User](#user_object).
241
242| Field | Type | Description |
243| :------------------- | :-------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
244| `listed` | `boolean` | true = Allows the Event to be publicly searchable on the Eventbrite website. |
245| `shareable` | `boolean` | true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
246| `invite_only` | `boolean` | true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
247| `show_remaining` | `boolean` | true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
248| `password` | `string` | Event password used by visitors to access the details of the Event. |
249| `capacity` | `integer` | Maximum number of tickets for the Event that can be sold to [Attendees](#attendee_object). The total capacity is calculated by the sum of the quantity_total of the [Ticket Class](#ticket_class_object). |
250| `capacity_is_custom` | `boolean` | true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
251
252<a name="music_properties_object"></a>
253
254#### Music Properties
255
256The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the `music_properties` expansion.
257
258| Field | Type | Description |
259| :---------------- | :------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
260| `age_restriction` | `enum` | Minimum age requirement of event attendees. |
261| `presented_by` | `string` | Main music event sponsor. |
262| `door_time` | `string` | Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
263
264<a name="event_expansions" />
265
266#### Expansions
267
268Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
269
270| Expansion | Source | Description |
271| :------------------------ | :-------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
272| `logo` | `logo_id` | Event image logo. |
273| `venue` | `venue_id` | Event [Venue](#venue_object). |
274| `organizer` | `organizer_id` | Event [Organizer](#organizer_object). |
275| `format` | `format_id` | Event [Format](#formats_object). |
276| `category` | `category_id` | Event [Category](#categories_object). |
277| `subcategory` | `subcategory_id` | Event [Subcategory](#subcategories_object). |
278| `bookmark_info` | `bookmark_info` | Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like `{count:3}`. |
279| `refund_policy` | `refund_policy` | Event [Refund Policy](#refund_policy_object). |
280| `ticket_availability` | `ticket_availability` | Overview of availability of all Ticket Classes |
281| `external_ticketing` | `external_ticketing` | External ticketing data for the Event. |
282| `music_properties` | `music_properties` | Event [Music Properties](#music_properties_object) |
283| `publish_settings` | `publish_settings` | Event publish settings. |
284| `basic_inventory_info` | `basic_inventory_info`| Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
285| `event_sales_status` | `event_sales_status` | Event’s sales status details |
286| `checkout_settings ` | `checkout_settings` | Event checkout and payment settings. |
287| `listing_properties` | `listing_properties` | Display/listing details about the event |
288| `has_digital_content` | `has_digital_content` | Whether or not an event [Has Digital Content](#has_digital_content_object) |
289
290
291**events** — <a name="event_object"></a>
292
293## Event Object
294
295The Event object represents an Eventbrite Event. An Event is owned by one [Organization](#organization_object).
296
297#### Public Fields
298
299Use these fields to specify information about an Event. For publicly listed Events, this information can be retrieved by all Eventbrite [Users](#user_object) and Eventbrite applications.
300
301| Field | Type | Description |
302| :---------------- | :--------------- | ------------------------------------------------------------------------------------------------------- |
303| `name` | `multipart-text` | Event name. |
304| `summary` | `string` | (Optional) Event summary. Short summary describing the event and its purpose. |
305| `description` | `multipart-text` | (*DEPRECATED*) (Optional) Event description. Description can be lengthy and have significant formatting. |
306| `url` | `string` | URL of the Event's Listing page on eventbrite.com. |
307| `start` | `datetime-tz` | Event start date and time. |
308| `end` | `datetime-tz` | Event end date and time. |
309| `created` | `datetime` | Event creation date and time. |
310| `changed` | `datetime` | Date and time of most recent changes to the Event. |
311| `published` | `datetime` | Event publication date and time. |
312| `status` | `string` | Event status. Can be `draft`, `live`, `started`, `ended`, `completed` and `canceled`. |
313| `currency` | `string` | Event [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. |
314| `online_event` | `boolean` | true = Specifies that the Event is online only (i.e. the Event does not have a [Venue](#venue_object)). |
315| `hide_start_date` | `boolean` | If true, the event's start date should never be displayed to attendees. |
316| `hide_end_date` | `boolean` | If true, the event's end date should never be displayed to attendees. |
317
318#### Private Fields
319
320Use these fields to specify properties of an Event that are only available to the [User](#user_object).
321
322| Field | Type | Description |
323| :------------------- | :-------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
324| `listed` | `boolean` | true = Allows the Event to be publicly searchable on the Eventbrite website. |
325| `shareable` | `boolean` | true = Event is shareable, by including social sharing buttons for the Event to Eventbrite applications. |
326| `invite_only` | `boolean` | true = Only invitees who have received an email inviting them to the Event are able to see Eventbrite applications. |
327| `show_remaining` | `boolean` | true = Provides, to Eventbrite applications, the total number of remaining tickets for the Event. |
328| `password` | `string` | Event password used by visitors to access the details of the Event. |
329| `capacity` | `integer` | Maximum number of tickets for the Event that can be sold to [Attendees](#attendee_object). The total capacity is calculated by the sum of the quantity_total of the [Ticket Class](#ticket_class_object). |
330| `capacity_is_custom` | `boolean` | true = Use custom capacity value to specify the maximum number of Attendees for the Event. False = Calculate the maximum number of Attendees for the Event from the total of all Ticket Class capacities. |
331
332<a name="music_properties_object"></a>
333
334#### Music Properties
335
336The Music Properties object includes a few attributes of an event for Music clients. To retrieve Music Properties by Event ID, use the `music_properties` expansion.
337
338| Field | Type | Description |
339| :---------------- | :------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
340| `age_restriction` | `enum` | Minimum age requirement of event attendees. |
341| `presented_by` | `string` | Main music event sponsor. |
342| `door_time` | `string` | Time relative to UTC that the doors are opened to allow people in the the day of the event. When not set, the event will not have any door time set. 2019-05-12T-19:00:00Z |
343
344<a name="event_expansions" />
345
346#### Expansions
347
348Information from expansions fields are not normally returned when requesting information. To receive this information in a request, expand the request.
349
350| Expansion | Source | Description |
351| :------------------------ | :-------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
352| `logo` | `logo_id` | Event image logo. |
353| `venue` | `venue_id` | Event [Venue](#venue_object). |
354| `organizer` | `organizer_id` | Event [Organizer](#organizer_object). |
355| `format` | `format_id` | Event [Format](#formats_object). |
356| `category` | `category_id` | Event [Category](#categories_object). |
357| `subcategory` | `subcategory_id` | Event [Subcategory](#subcategories_object). |
358| `bookmark_info` | `bookmark_info` | Indicates whether a user has saved the Event as a bookmark. Returns false if there are no bookmarks. If there are bookmarks, returns a a dictionary specifying the number of end-users who have bookmarked the Event as a count object like `{count:3}`. |
359| `refund_policy` | `refund_policy` | Event [Refund Policy](#refund_policy_object). |
360| `ticket_availability` | `ticket_availability` | Overview of availability of all Ticket Classes |
361| `external_ticketing` | `external_ticketing` | External ticketing data for the Event. |
362| `music_properties` | `music_properties` | Event [Music Properties](#music_properties_object) |
363| `publish_settings` | `publish_settings` | Event publish settings. |
364| `basic_inventory_info` | `basic_inventory_info`| Indicates whether the event has Ticket Classes, Inventory Tiers, Donation Ticket Classes, Ticket Rules, Inventory Add-Ons, and/or Admission Inventory Tiers. |
365| `event_sales_status` | `event_sales_status` | Event’s sales status details |
366| `checkout_settings ` | `checkout_settings` | Event checkout and payment settings. |
367| `listing_properties` | `listing_properties` | Display/listing details about the event |
368| `has_digital_content` | `has_digital_content` | Whether or not an event [Has Digital Content](#has_digital_content_object) |
369
370- `eventbrite-pp-cli events delete-an` — Delete an Event if the delete is permitted. Returns a boolean indicating the success or failure of the delete action.
371- `eventbrite-pp-cli events retrieve-an` — Retrieve an Event by Event ID.
372- `eventbrite-pp-cli events update-an` — Update Event by Event ID.
373
374**formats** — <a name="formats_object"></a>
375
376## Format Object
377
378The Format object represents an [Event](#event_object) type, for example seminar, workshop or concert. Specifying a Format helps website visitors discover a certain type of Event.
379
380- `eventbrite-pp-cli formats list` — List all available Formats. Returns a paginated response.
381- `eventbrite-pp-cli formats retrieve-a` — Retrieve a Format by Format ID.
382
383**media** — <!-- Here is a tutorial on [Media Upload in EventBrite](https://www.eventbrite.com/developer/v3/resources/uploads/). -->
384
385<a name="media_object"></a>
386
387## Media Object
388
389The Media object represents an image that can be included with an [Event](#event_object) listing, for example to provide branding or further information on the Event.
390
391- `eventbrite-pp-cli media retrieve` — Retrieve Media by Media ID.
392- `eventbrite-pp-cli media retrieve-a-upload` — Retrieve information on a Media image upload.
393- `eventbrite-pp-cli media upload-a-file` — Upload a Media image file.
394
395**orders** — <a name="order_object"></a>
396
397## Order object
398
399The Order object represents an order made against Eventbrite for one or more [Ticket Classes](#ticket_class_object). In other words, a single Order can be made up of multiple tickets. The object contains an Order's financial and transactional information; use the [Attendee](#attendee_object) object to return information on Attendees.
400
401Order objects are considered private; meaning that all Order information is only available to the Eventbrite [User](#user_object) and Order owner.
402
403#### Order Fields
404
405| Field | Type | Description |
406| :--------------- | :---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
407| `created` | `datetime` | Date and time the Order was placed and the Attendee created. |
408| `changed` | `datetime` | Date and time of the last change to Attendee. |
409| `name` | `string` | Order owner name. To ensure forward compatibility with non-Western names, use this field instead of `first_name`/`last_name`. |
410| `first_name` | `string` | Order owner first name. Use `name` field instead. |
411| `last_name` | `string` | Order owner last name. Use `name` field instead. |
412| `email` | `string` | Order owner email address. |
413| `costs` | [order-costs](#order_cost) | Cost breakdown of the Order. |
414| `event_id` | `string` | Order's [Event](#event_object) ID. |
415| `time_remaining` | `number` | Time remaining to complete Order (in seconds). |
416| `questions` | [order-questions](#order_questions) | (Optional) Custom questions shown to Order's owner. |
417| `answers` | [order-answers](#order_answers) | (Optional) Answers to custom questions shown to Order's owner. |
418| `promo_code` | `string` | (Optional) [Discount](#discount_object) code applied to Order. |
419| `status` | `string` | Order status. |
420
421<a name="order_cost"></a>
422
423#### Order Costs Fields
424
425Contains a breakdown of Order costs.
426
427| Field | Type | Description |
428| :---------------------- | :-------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
429| `base_price` | `currency` | Order amount without fees and tax. Use instead the `display_price` field if the [Ticket Class](#ticket_class_object) `include_fee` field is used; otherwise an incorrect value is shown to the Order owner. |
430| `display_price` | `currency` | Order amount without fees and tax. This field shows the correct value to the Order owner when the Ticket Class `include_fee` field is used. |
431| `display_fee` | `currency` | Order amount with fees and tax included (absorbed) in the price as displayed. |
432| `gross` | `currency` | Total amount of Order. |
433| `eventbrite_fee` | `currency` | Eventbrite fee as portion of Order `gross` amount. Do not expose this field to Order owner. |
434| `payment_fee` | `currency` | Payment processor fee as portion of Order `gross` amount. |
435| `tax` | `currency` | Tax as portion of Order `gross` amount passed to Event [Organization](#organization_object). |
436| `display_tax` | [order-display-tax](#order_display_tax) | Order tax. Same value as `tax` field, but also includes the tax name. |
437| `price_before_discount` | `currency` | Order price before a [Discount](#discount_object) code is applied. If no discount code is applied, value should be equal to `display_price`. |
438| `discount_amount` | `currency` | Order total Discount. If no discount code is applied, discount_amount will not be returned. |
439| `discount_type` | `string` | Type of Discount applied to Order. Can be `null` or `coded`, `access`, `public` or `hold`. If no discount code is applied, discount_type will not be returned. |
440| `fee_components` | `Cost Component` (list) | List of price costs components that belong to the fee display group. |
441| `tax_components` | `Cost Component` (list) | List of price costs components that belong to the tax display group. |
442| `shipping_components` | `Cost Component` (list) | List of price costs components that belong to the shippig display group. |
443| `has_gts_tax` | `boolean` | Indicates if any of the tax_components is a gts tax. |
444| `tax_name` | `string` | The name of the tax that applies, if any. |
445
446<a name="order_display_tax"></a>
447
448#### Display Tax Fields
449
450| Field | Type | Description |
451| :----- | :--------- | ----------- |
452| `name` | `string` | Tax name. |
453| `tax` | `currency` | Tax amount. |
454
455#### Refund Request Fields
456
457The Order includes a refund request.
458
459| Field | Type | Description |
460| :------------- | :--------------------- | ------------------------------------------------------------------- |
461| `from_email` | `string` | Email used to create the refund request. |
462| `from_name` | `string` | Refund request name. |
463| `status` | `string` | Refund request status. |
464| `message` | `string` | Message associated with the refund request. |
465| `reason` | `string` | Refund request reason code. |
466| `last_message` | `string` | Last message associated with the last status of the refund request. |
467| `last_reason` | `string` | Last reason code of the refund request. |
468| `items` | list of [refund_item](#refund_item) | Requested refunded items of the refund request. |
469
470<a name="refund_item"></a>
471
472#### Refund Item Fields
473
474A Refund Request contains a refund item.
475
476| Field | Type | Description |
477| :----------------------- | :--------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
478| `event_id` | `string` | Refund item Event. |
479| `order_id` | `string` | Refund item Order. Field can be `null`. |
480| `processed_date` | `datetime` | (Optional) The date and time this refund item was processed, if it has been processed. |
481| `item_type` | `string` | Refund item Order type. Use `order` for full refund, `attendee` for partial refund for the Attendee, or `merchandise` for partial refund as merchandise. |
482| `amount_processed` | `currency` | (Optional) The amount of money refunded. This will be absent if the refund has not been processed. |
483| `amount_requested` | `currency` | (Optional) The amount of money requested for refund. Only appears for attendee-initiated refunds. |
484| `quantity_processed` | `number` | (Optional) Quantity refunded. If the `item_type` field value is `order`, `quantity_processed` is always 1. If the `item_type` field value is `attendee` or `merchandise`, then the `quantity_processed` value displays the number of items processed. This will be absent if the refund has not been processed. |
485| `quantity_requested` | `number` | (Optional) Quantity requested to be refunded. If the `item_type` is `order`, `quantity_requested` is always 1. If the `item_type` is `attendee` or `merchandise`, then the `quantity_requested` value displays the number of items requested for a refund. Only appears for attendee-initiated refund items. |
486| `refund_reason_code` | `string` | A descriptive code for the refund reason |
487| `status` | `string` | Refund item status, one of `pending`, `processed`, or `error` |
488
489<a name="order_questions"></a>
490
491#### Order Questions Fields
492
493Use to present Custom Questions to an Attendee.
494
495| Field | Type | Description |
496| :--------- | :-------- | ------------------------------------------------------------------------- |
497| `id` | `string` | Custom Question ID. |
498| `label` | `string` | Custom Question Label. |
499| `type` | `string` | Can be `text`, `url`, `email`, `date`, `number`, `address`, or `dropdown` |
500| `required` | `boolean` | true = Answer to custom question is required. |
501
502<a name="order_answers"></a>
503
504#### Order Answers Fields
505
506Contains information on an Attendee's answers to custom questions.
507
508| Field | Type | Description |
509| :------------ | :------- | ---------------------------------------------------------------------------------------------------------------- |
510| `question_id` | `string` | Custom Question ID. |
511| `attendee_id` | `string` | Attendee ID. |
512| `question` | `string` | Custom Question text. |
513| `type` | `string` | Can be `text`, `url`, `email`, `date`, `number`, `address`, or `dropdown`. |
514| `answer` | varies | Answer type. Generally use the `string` value; except when an answer of `address` or `date` is more appropriate. |
515
516#### Order Notes Fields
517
518Order Notes is free-form text related to an Order.
519
520| Field | Type | Description |
521| :------------ | :--------- | ------------------------------------------------------------------ |
522| `created` | `datetime` | Order note creation date and time. |
523| `text` | `string` | Order note content up to 2000 characters. |
524| `type` | `string` | Type of Order associated with order note, always and only `order`. |
525| `event_id` | `event` | ID of Event associated with Order. |
526| `order_id` | `order` | ID of Order associated with order note. |
527| `author_name` | `string` | First and last name Order owner associated with order note. |
528
529#### Expansions
530
531Information from expansions fields are not normally returned when requesting information.
532To receive this information in a request, expand the request.
533
534| Expansion | Source | Description |
535| :--------------------------- | :------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
536| `event` | `event_id` | Order's associated Event. |
537| `attendees` | `attendee`(list) | Order's Attendees. |
538| `merchandise` | `merchandise`(list) | Merchandise included in this Order. |
539| `concierge` | `concierge` | Order's concierge. |
540| `refund_requests` | `refund_request` | Order's refund request. |
541| `survey` | `order-questions` | (Optional) Order's custom questions. |
542| `survey_responses` | `order-survey-responses`(object) | (Optional) Order's responses to survey questions. |
543| `answers` | `order-answers` | (Optional) Order's answers to custom questions. |
544| `ticket_buyer_settings` | `ticket_buyer_settings` | (Optional) Include information relevant to the purchaser, including confirmation messages. |
545| `contact_list_preferences` | `contact_list_preferences` | (Optional) Opt-in preferences for the email address associated with the Order. |
546
547- `eventbrite-pp-cli orders <order_id>` — Retrieve an Order by Order ID.
548
549**organizations** — <a name="organization_object"></a>
550
551## Organization Object
552
553An object representing a business structure (like a Marketing department) in which [Events](#event_object) are created and managed. Organizations are owned by one [User](#users_object) and can have multiple [Members](#members_object).
554
555The Organization object is used to group Members, [Roles](#roles_object), [Venues](#venue_object) and [Assortments](#assortments_object).
556
557#### Public Fields
558
559Use these fields to specify information about an Organization.
560
561| Field | Type | Description |
562| :--------- | :------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
563| `id` | `string` | Organization ID. Must be obtained via an API request, such as a List your Organizations request. The `organization_id` is NOT equal to an `organizer_id` (the string in an Organizer Profile URL). |
564| `name` | `string` | Organization Name. |
565| `image_id` | `string` | (Optional) ID of the image for an Organization. |
566| `vertical` | `string` | Type of business vertical within which this Organization operates. Currently, the only values are `default` and `music`. If not specified, the value is `default`. |
567
568
569**pricing** — <a name="Pricing_object"></a>
570
571## Pricing Object
572
573The Pricing object represents all the available fee rates for different currencies, countries, [Assortments](#assortments_object) and sales channels.
574
575- `eventbrite-pp-cli pricing calculate-items` — Calculates the Fees that Eventbrite would charge for a given price as it’s shown on the ticket authoring flow.
576- `eventbrite-pp-cli pricing list` — List all available Pricing rates. Returns a paginated response.
577
578**reports** — <a name="reports_object"></a>
579
580## Report Object
581
582The Report object represents the Reports that you can retrieve using the API. This includes Reports on:
583
584+ Sales activity
585
586+ [Attendees](#attendee_object) for an [Event](#event_object).
587
588- `eventbrite-pp-cli reports retrieve-a-attendee` — Retrieve an Attendee Report by Event ID or Event status.
589- `eventbrite-pp-cli reports retrieve-a-sales` — Retrieve a sales Report by Event ID or Event status.
590
591**series** — Manage series
592
593- `eventbrite-pp-cli series <event_series_id>` — Retrieve the parent Event Series by Event Series ID.
594
595**subcategories** — Manage subcategories
596
597- `eventbrite-pp-cli subcategories list-of` — List all available Subcategories. Returns a paginated response.
598- `eventbrite-pp-cli subcategories subcategory-by-id` — Retrieve a Subcategory by Subcategory ID.
599
600**ticket-groups** — <a name="ticket_group_object"></a>
601
602## Ticket Group Object
603
604The Ticket Group object is used to group [Ticket Classes](#ticket_class_object).
605
606Most commonly used to apply a [Cross-Event Discount](#discount_object) to multiple Ticket Classes.
607
608#### Fields
609
610| Field | Type | Description |
611| :----------------- | :----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
612| `name` | `string` | Ticket Group name. A name containing more than 20 characters is automatically truncated. |
613| `status` | `string` | Ticket Group status. Can be `transfer`, `live`, `deleted` or `archived`. By default, the status is `live`. |
614| `event_ticket_ids` | `dict` | Dictionary showing the Ticket Class IDs associated with a specific Event ID. |
615| `tickets` | `objectlist` | List of Ticket Class. Includes for each Ticket Class `id`, `event_id`, `sales_channels`, `variants` and `name`. By default this field is empty, unless the Ticket Class Expansions fields are used. |
616
617- `eventbrite-pp-cli ticket-groups delete-a` — Delete a Ticket Group. The status of the Ticket Group is changed to `deleted`.
618- `eventbrite-pp-cli ticket-groups retrieve-a` — Retrieve a Ticket Group by Ticket Group ID.
619- `eventbrite-pp-cli ticket-groups update-a` — Update Ticket Group by Ticket Group ID.
620
621**users** — >**Note:** Note These URLs will accept “me” in place of a user ID in URLs - for example, /users/me/orders/ will return orders placed by the current user.
622
623<a name="user_object"></a>
624
625## User Object
626
627User is an object representing an Eventbrite account. Users are [Members](#members_object) of an [Organization](#organization_object).
628
629- `eventbrite-pp-cli users list-your-organizations` — List the Organizations to which you are a Member. Returns a paginated response.
630- `eventbrite-pp-cli users retrieve-information-about-a-account` — Returns a user for the specified `user` as user.
631- `eventbrite-pp-cli users retrieve-information-about-your-account` — Retrieve Information About Your User Account
632
633**venues** — <a name="venue_object"></a>
634
635## Venue Object
636
637The Venue object represents the location of an [Event](#event_object) (i.e. where an Event takes place).
638
639Venues are grouped together by the [Organization](#organization_object) object.
640
641#### Venue Fields
642
643| Field | Type | Description |
644| :---------------- | :-------- | ---------------------------------------------------------- |
645| `address` | `address` | Venue address. |
646| `id` | `string` | Venue ID. |
647| `age_restriction` | `string` | Age restriction of the Venue. |
648| `capacity` | `number` | Maximum number of tickets that can be sold for the Venue. |
649| `name` | `string` | Venue name. |
650| `latitude` | `string` | Latitude coordinates of the Venue address. |
651| `longitude` | `string` | Longitude coordinates of the Venue address. |
652
653- `eventbrite-pp-cli venues retrieve-a` — Retrieve a Venue by Venue ID.
654- `eventbrite-pp-cli venues update-a` — Update a Venue by Venue ID.
655
656**webhooks** — <a name="webhooks_object"></a>
657
658## Webhook Object
659
660An object representing a webhook associated with the Organization.
661
662- `eventbrite-pp-cli webhooks create-deprecated` — Create a Webhook. > Warning: Access to this API will be no longer usable on June 1st, 2020.
663- `eventbrite-pp-cli webhooks delete-by-id` — Delete a Webhook by ID.
664- `eventbrite-pp-cli webhooks list-of-deprecation` — List Webhooks. > Warning: Access to this API will be no longer usable on June 1st, 2020.
665
666
667### Finding the right command
668
669When you know what you want to do but not which command does it, ask the CLI directly:
670
671```bash
672eventbrite-pp-cli which "<capability in your own words>"
673```
674
675`which` resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code `0` means at least one match; exit code `2` means no confident match — fall back to `--help` or use a narrower query.
676
677## Recipes
678
679### Find your slowest-selling live events
680
681```bash
682eventbrite-pp-cli sales-velocity --json
683```
684
685Ranks every live event by tickets sold per day since on-sale with a projected sell-out date, computed from the local order store.
686
687### Surface returning fans for re-marketing
688
689```bash
690eventbrite-pp-cli repeat-attendees --min 3 --agent --select email,name,events_count
691```
692
693Cross-event attendee join; --agent emits structured rows and --select narrows to just the contact fields an email tool needs.
694
695### Door check-in roster, offline
696
697```bash
698eventbrite-pp-cli roster 1234567890 --csv
699```
700
701Prints the synced attendee roster for one event with checked-in status as CSV for a will-call sheet — no live API call required.
702
703### Agency Friday client roll-up
704
705```bash
706eventbrite-pp-cli org-rollup --json
707```
708
709One pane across every organization the token can see: events, tickets sold, gross, and top event per client org.
710
711### Measure a promo code's ROI
712
713```bash
714eventbrite-pp-cli discount-performance --json
715```
716
717Ranks discount codes by redemptions and redemption rate (share of each code's allotment used) from the synced discount objects.
718
719### Combine Eventbrite + DICE for full event performance
720
721```bash
722eventbrite-pp-cli fan-export --json
723```
724
725Export your Eventbrite buyer/attendee list as JSON; a promoter selling the same show on DICE exports the DICE side too, then an agent joins events by name and date and buyers by normalized email for a cross-platform performance and loyalty view no single platform shows.
726
727## Auth Setup
728
729Eventbrite uses an OAuth2 private token sent as a Bearer header. For your own account you do not need the full OAuth dance — copy a private token from eventbrite.com/platform/api-keys and set EVENTBRITE_API_KEY. Run `eventbrite-pp-cli doctor` to confirm it is picked up.
730
731## Agent Mode
732
733Add `--agent` to any command. Expands to: `--json --compact --no-input --no-color --yes`.
734
735- **Pipeable** — JSON on stdout, errors on stderr
736- **Filterable** — `--select` keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
737
738 ```bash
739 eventbrite-pp-cli formats list --agent --select id,name,status
740 ```
741- **Previewable** — `--dry-run` shows the request without sending
742- **Offline-friendly** — sync/search commands can use the local SQLite store when available
743- **Non-interactive** — never prompts, every input is a flag
744- **Explicit retries** — use `--idempotent` only when an already-existing create should count as success, and `--ignore-missing` only when a missing delete target should count as success
745
746### Response envelope
747
748Commands that read from the local store or the API wrap output in a provenance envelope:
749
750```json
751{
752 "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
753 "results": <data>
754}
755```
756
757Parse `.results` for data and `.meta.source` to know whether it's live or local. A human-readable `N results (live)` summary is printed to stderr only when stdout is a terminal AND no machine-format flag (`--json`, `--csv`, `--compact`, `--quiet`, `--plain`, `--select`) is set — piped/agent consumers and explicit-format runs get pure JSON on stdout.
758
759## Agent Feedback
760
761When you (or the agent) notice something off about this CLI, record it:
762
763```
764eventbrite-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
765eventbrite-pp-cli feedback --stdin < notes.txt
766eventbrite-pp-cli feedback list --json --limit 10
767```
768
769Entries are stored locally at `~/.eventbrite-pp-cli/feedback.jsonl`. They are never POSTed unless `EVENTBRITE_FEEDBACK_ENDPOINT` is set AND either `--send` is passed or `EVENTBRITE_FEEDBACK_AUTO_SEND=true`. Default behavior is local-only.
770
771Write what *surprised* you, not a bug report. Short, specific, one line: that is the part that compounds.
772
773## Output Delivery
774
775Every command accepts `--deliver <sink>`. The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:
776
777| Sink | Effect |
778|------|--------|
779| `stdout` | Default; write to stdout only |
780| `file:<path>` | Atomically write output to `<path>` (tmp + rename) |
781| `webhook:<url>` | POST the output body to the URL (`application/json` or `application/x-ndjson` when `--compact`) |
782
783Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.
784
785## Named Profiles
786
787A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.
788
789```
790eventbrite-pp-cli profile save briefing --json
791eventbrite-pp-cli --profile briefing formats list
792eventbrite-pp-cli profile list --json
793eventbrite-pp-cli profile show briefing
794eventbrite-pp-cli profile delete briefing --yes
795```
796
797Explicit flags always win over profile values; profile values win over defaults. `agent-context` lists all available profiles under `available_profiles` so introspecting agents discover them at runtime.
798
799## Exit Codes
800
801| Code | Meaning |
802|------|---------|
803| 0 | Success |
804| 2 | Usage error (wrong arguments) |
805| 3 | Resource not found |
806| 4 | Authentication required |
807| 5 | API error (upstream issue) |
808| 7 | Rate limited (wait and retry) |
809| 10 | Config error |
810
811## Argument Parsing
812
813Parse `$ARGUMENTS`:
814
8151. **Empty, `help`, or `--help`** → show `eventbrite-pp-cli --help` output
8162. **Starts with `install`** → ends with `mcp` → MCP installation; otherwise → see Prerequisites above
8173. **Anything else** → Direct Use (execute as CLI command with `--agent`)
818
819## MCP Server Installation
820
8211. Install the MCP server:
822 ```bash
823 go install github.com/mvanhorn/printing-press-library/library/media-and-entertainment/eventbrite/cmd/eventbrite-pp-mcp@latest
824 ```
8252. Register with Claude Code:
826 ```bash
827 claude mcp add eventbrite-pp-mcp -- eventbrite-pp-mcp
828 ```
8293. Verify: `claude mcp list`
830
831## Direct Use
832
8331. Check if installed: `which eventbrite-pp-cli`
834 If not found, offer to install (see Prerequisites at the top of this skill).
8352. Match the user query to the best command from the Unique Capabilities and Command Reference above.
8363. Execute with the `--agent` flag:
837 ```bash
838 eventbrite-pp-cli <command> [subcommand] [args] --agent
839 ```
8404. If ambiguous, drill into subcommand help: `eventbrite-pp-cli <command> --help`.