Events · People
People and the door (#2487): the hosts' guest list and export, adding people, approving requests, refunds and refund requests, the waitlist, messaging guests, and door check-in (also for volunteers whose role checks people in, during the event), offline with a batch sync. For an event's accepted hosts and staff with manage_events. Behind features.events.
People
Every order with its tickets, the counts (going, members and guests, checked in, requests, refund requests, waitlist, revenue) and the waitlist. One row per reservation (#2709): party_code (null until the order admits anyone), party_size, checked_in_count, vip, invite_id. q matches the buyer's and named guests' names and emails, a VIP guest's email and the order number ("1042" or "#1042"). revenue_cents is ticket revenue: the tickets' money only, never gifts or a fee the buyer covered.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"Query Parameters
"going""requested""checked_in""not_checked_in""refunds""cancelled"Responses
People.
Add people
A member or someone without an account: a comp or paid outside FundlyHub (confirmed at once, no money), or a payment link (held 48 hours and emailed). Hidden ticket types may be used. A comp may instead explicitly request complimentary admission. A genuinely unconfigured free event first restores its canonical public RSVP types (one per saved day for one-day-each events); otherwise a hidden free admission type is reused or created atomically without changing configured ticket sales or registration. Select a saved event day for one-day-each admission. Audited. With Idempotency-Key (#2709) a repeat answers the order the first added (and its payment_link_token).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Header Parameters
Optional (#2709): 16 to 200 of [A-Za-z0-9_.:-], a uuid. Kept two days, scoped to the endpoint, the event and the caller.
"^[A-Za-z0-9_.:-]{16,200}$"Path Parameters
The event's id.
"uuid"Request Body
Responses
Added.
Add many people
Up to 200 people at once (#2716) with the settings of one add (see Add people): each row is added in order by the single add, in its own transaction with its own seat check, emails and audit entry; never all or nothing. A row that fails (no seats left, an invalid email, a member twice in the list) is reported and the rest are still added. A payment link needs each guest's email (a member's is their account's); send_email emails the ticket to those with an address and skips the rest. A refusal about the settings (unknown_ticket_type, free_ticket, wrong_day, ...) stops the batch: before anyone is added it is the answer, as the single add's would be; after, the rows left fail with it. With Idempotency-Key each row is kept under <key>:bulk:<index>, so a retried batch answers what each row made and adds nobody twice (a row that failed is tried again). Rate limited per account: ten batches in ten minutes, with the guest-invite bulk add.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Header Parameters
Optional (#2709): 16 to 200 of [A-Za-z0-9_.:-], a uuid. Kept two days, scoped to the endpoint, the event and the caller.
"^[A-Za-z0-9_.:-]{16,200}$"Path Parameters
The event's id.
"uuid"Request Body
Responses
Each row's result, in order.
People, as a spreadsheet
One row per reservation (#2709): order, status, name, email, member, party_size, checked_in, vip, ticket_types, dietary, tickets_usd, added_by.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"Responses
CSV.
Approve every request
One by one; a card that can't be charged declines only its own request.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"Responses
What happened to each.
Offer a seat to someone in line
Their seats for 24 hours, emailed.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"The waitlist place's id.
"uuid"Responses
Offered.
Message every guest
An email (and bell) to everyone with a ticket. Audited.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"Request Body
Responses
Queued.
Decline a refund request
The order stays as it is; the buyer hears it, with the note. Audited.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"The refund request's id.
"uuid"Request Body
Responses
Declined.
Approve a request
The order's event's hosts and staff. A paid request is captured (charged) and split into gifts; a free one is confirmed. A card that can't be charged declines it. Audited.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The order's id.
"uuid"Responses
Approved.
Rename a guest without an account
The order's event's hosts and staff (#2768). Corrects the name of a guest who has no FundlyHub account. The reservation, its first ticket and the VIP invite it came from all take the new name. A member's name comes from their account and is refused. Audited. A VIP invite still open is renamed with PATCH /events/{id}/guest-invites/{inviteId} and name.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The order's id.
"uuid"Request Body
Responses
Renamed.
Decline a request
The card's hold is released; nothing is charged. Audited.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The order's id.
"uuid"Responses
Declined.
Refund an order
All of it (every ticket, the gift and a covered fee) or some tickets, until 30 days after the event. Split by the same shares across the gifts; a gift already paid out has its transfer reversed by its part; each gift's ledger reverses through the existing refund path. Any open refund request is closed as refunded. Audited, with the hosts' note, which the buyer's refund email also carries.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The order's id.
"uuid"Request Body
Responses
Refunded.
The door list
The day's guest list with codes, for the door phone to keep and scan offline. Hosts and staff, and volunteers whose role checks people in (from a day before the event until it ends). Never cached.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"Query Parameters
The day (else the one under way, else the first).
"uuid"Responses
The list.
Find a ticket at the door
By code (exact) or name: tickets (each with its order's party_code), and (#2709) parties by party code (exact) or holder name.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"Query Parameters
"uuid"Responses
Matches.
Check in
One check-in, or the batch a phone made offline with its own times (offline: true). The first check-in of a ticket on a day wins: a repeat answers already_checked_in with its time. An offline undo removes only that phone's own check-in (its client_ref). A party (#2709): { party_code, count } at the top level or as an item checks in count of the order's active seats not in yet that day, a seat at a time (undo per seat still works).
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"Request Body
Responses
Each item's result.
Undo a check-in
From the door screen, for the day.
Authorizations
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Parameters
Path Parameters
The event's id.
"uuid"The ticket's id.
"uuid"Query Parameters
"uuid"Responses
Undone (or it was not checked in).