Skip to content

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​

GET
/events/{id}/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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Query Parameters

status
Type
string
Valid values
"going""requested""checked_in""not_checked_in""refunds""cancelled"
q
Type
string

Responses​

People.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Add people​

POST
/events/{id}/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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Header Parameters

Idempotency-Key

Optional (#2709): 16 to 200 of [A-Za-z0-9_.:-], a uuid. Kept two days, scoped to the endpoint, the event and the caller.

Type
string
Pattern
"^[A-Za-z0-9_.:-]{16,200}$"

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

Added.

application/json
JSON
{
"id": "string",
"status": "string",
"payment_link_token": "string"
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​


Add many people​

POST
/events/{id}/people/bulk

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Header Parameters

Idempotency-Key

Optional (#2709): 16 to 200 of [A-Za-z0-9_.:-], a uuid. Kept two days, scoped to the endpoint, the event and the caller.

Type
string
Pattern
"^[A-Za-z0-9_.:-]{16,200}$"

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"rows": [
],
"kind": "string",
"ticket_type_id": "string",
"complimentary_admission": true,
"quantity": 0,
"event_day_id": "string",
"language": "string",
"send_email": true
}

Responses​

Each row's result, in order.

application/json
JSON
{
"results": [
{
"index": 0,
"ok": true,
"order": {
"id": "string",
"status": "string",
"payment_link_token": "string"
}
}
],
"added": 0,
"failed": 0
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​


People, as a spreadsheet​

GET
/events/{id}/people.csv

One row per reservation (#2709): order, status, name, email, member, party_size, checked_in, vip, ticket_types, dietary, tickets_usd, added_by.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

CSV.

text/csv
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Approve every request​

POST
/events/{id}/approve-all

One by one; a card that can't be charged declines only its own request.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

What happened to each.

application/json
JSON
{
"results": [
{
"id": "string",
"status": "string"
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Offer a seat to someone in line​

POST
/events/{id}/waitlist/{entryId}/offer

Their seats for 24 hours, emailed.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
entryId*

The waitlist place's id.

Type
string
Required
Format
"uuid"

Responses​

Offered.

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Message every guest​

POST
/events/{id}/message

An email (and bell) to everyone with a ticket. Audited.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"subject": "string",
"message": "string"
}

Responses​

Queued.

application/json
JSON
{
"queued": true
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Decline a refund request​

POST
/events/{id}/refund-requests/{requestId}/decline

The order stays as it is; the buyer hears it, with the note. Audited.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
requestId*

The refund request's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"note": "string"
}

Responses​

Declined.

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Approve a request​

POST
/event-orders/{id}/approve

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The order's id.

Type
string
Required
Format
"uuid"

Responses​

Approved.

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Rename a guest without an account​

POST
/event-orders/{id}/name

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The order's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"name": "string"
}

Responses​

Renamed.

application/json
JSON
{
"id": "string",
"name": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Decline a request​

POST
/event-orders/{id}/decline

The card's hold is released; nothing is charged. Audited.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The order's id.

Type
string
Required
Format
"uuid"

Responses​

Declined.

application/json
JSON
{
"id": "string",
"status": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Refund an order​

POST
/event-orders/{id}/refund

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The order's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"all": true,
"ticket_ids": [
"string"
],
"note": "string"
}

Responses​

Refunded.

application/json
JSON
{
"id": "string",
"status": "string",
"refunded_cents": 0
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


The door list​

GET
/events/{id}/check-in/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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Query Parameters

day

The day (else the one under way, else the first).

Type
string
Format
"uuid"

Responses​

The list.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Find a ticket at the door​

GET
/events/{id}/check-in/search

By code (exact) or name: tickets (each with its order's party_code), and (#2709) parties by party code (exact) or holder name.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Query Parameters

q*
Type
string
Required
day
Type
string
Format
"uuid"

Responses​

Matches.

application/json
JSON
{
"day_id": "string",
"tickets": [
{
"additionalProperties": "string"
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Check in​

POST
/events/{id}/check-ins

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​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"event_day_id": "string",
"offline": true,
"party_code": "string",
"count": 0,
"items": [
{
"code": "string",
"party_code": "string",
"count": 0,
"at": "string",
"undo": true,
"client_ref": "string"
}
]
}

Responses​

Each item's result.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


Undo a check-in​

DELETE
/events/{id}/check-ins/{ticketId}

From the door screen, for the day.

Authorizations​

BearerAuth

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.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
ticketId*

The ticket's id.

Type
string
Required
Format
"uuid"

Query Parameters

day
Type
string
Format
"uuid"

Responses​

Undone (or it was not checked in).

application/json
JSON
{
"ticket_id": "string",
"day_id": "string",
"result": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Powered by VitePress OpenAPI

Built with VitePress