API-first

API
Reference.

Stripe-style keys, HMAC-signed webhooks, and an OpenAPI spec that CI verifies against the code. Every endpoint, every field.

Spec version 1.4.1 · updated 6 Nov 2026

REST API for integrating events, registrations, and tickets into your own website, app, or back-office.

Authentication

Two Stripe-style bearer keys, shown in the dashboard (API keys tab):

• Publishable (pk_…) — safe in browsers and apps: read published events, submit registrations, read categories/tags.

• Secret (sk_…) — your server only: everything, including attendee PII, check-in, exports, broadcasts, templates, and webhooks.

Send either as Authorization: Bearer <key>. Rotating a key immediately revokes the old one. Missing/invalid key → 401; a publishable key on a management endpoint → 403.

Plans. The secret key and webhooks are included in the Pro and Business plans. On Basic the publishable key (and the widget) works as usual, but every secret-key request is refused with 403 plan_limit, and adding, testing or pushing to a webhook endpoint returns 409 plan_limit.

Localization

Public content endpoints accept ?lang=<BCP-47> (e.g. zh-Hant). Resolution: exact locale → language family → the organizer's default (the platform's general categories fall back to English instead). Identifiers never localize — category/tag slugs, custom-field keys, and option values are stable; only display labels change.

Rate limits

Per IP: 200 requests/min globally; stricter on sensitive endpoints (registrations 10/min/event, exports 10/min, broadcasts 5/10min). 429 means back off.

Errors

Every error is { "error": <stable code>, "message": <human text> }. Codes include invalid_request, not_found, conflict, plan_limit, trial_expired, invalid_locale, already_registered, sold_out, registration_closed, invalid_answers, unknown_placeholders, captcha_failed.

Dashboard-session-only endpoints (login, profile, company settings, team) are out of scope here — they are not part of the key-authenticated integration surface.

Versioning

The API is versioned in the path (/v1/). Backwards-compatible changes — new endpoints, new optional request fields, new response fields, new webhook event types — ship within a version at any time, so ignore fields you do not recognise. Changes that would break an existing integration only ever arrive as a new path version. When a version is retired, owners of accounts that hold API keys get at least 12 months' notice and the old version keeps working, with security fixes, for that whole period. Every change is listed under What's new with the spec version it shipped in.

Events

Public listing (publishable key) and full event management (secret key). Recurring events carry recurring: true plus an occurrences array; attendees register per date via occurrenceId.

get/v1/eventspk_ or sk_

List events

Publishable key: published events currently inside their publish window (recurring events with no upcoming dates drop out). Secret key: every event, with management fields. Pagination slices after visibility/category/tag filters, so offsets are stable against what the caller can see.

Parameters
NameInType
langquery string

BCP-47 locale for localized labels/content (e.g. zh-Hant).

categoryquery string

Filter by category slug.

tagquery string

Filter by tag slug.

limitquery integer

Page size. Omit (with offset) for the full list.

offsetquery integer

Rows to skip. Page with offset += limit until offset >= total.

Responses
200

Event list with paging metadata.

{
  events: [  // optional
    {
      id: string
      title: string
      description: string  // nullable · Plain-text card summary.
      descriptionBlocks: [  // optional
        {
          id: string  // required
          type: "text" | "image" | "video" | "faq" | "lineup" | "agenda"  // required
          text: string
          url: string
          urls: string[]
          alt: string  // nullable
          layout: "full" | "text-left" | "text-right"
          provider: "youtube" | "vimeo"
          videoId: string
          items: object[]
        }
      ]
      location: string  // nullable
      startsAt: string  // For recurring events, the NEXT upcoming date.
      endsAt: string  // nullable
      capacity: integer  // nullable · Recurring events: public value is the series total over upcoming dates.
      spotsLeft: integer  // nullable · null = unlimited. Reported as 0 while a waitlist queue holds freed spots.
      category: string  // nullable · Stable slug.
      categoryLabel: string  // nullable · Localized display label.
      tags: string[]  // Stable slugs.
      tagLabels: [  // optional
        {
          slug: string
          label: string
        }
      ]
      bannerUrl: string  // nullable
      thumbnailUrl: string  // nullable
      customFields: [  // optional
        {
          key: string  // required
          label: string  // required
          type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox"  // required
          required: boolean
          helpText: string  // nullable
          options: [  // optional
            {
              value: string
              label: string
            }
          ]
        }
      ]
      registrationStatus: "open" | "scheduled" | "closed" | "disabled"
      registrationOpensAt: string  // nullable
      registrationClosesAt: string  // nullable
      waitlistOpen: boolean
      recurring: boolean
      nextOccurrenceAt: string  // nullable
      occurrences: [  // optional
        {
          id: string
          startsAt: string
          endsAt: string  // nullable
          capacity: integer  // nullable · Per-date override; null = event default.
          spotsLeft: integer  // nullable
          registrationStatus: "open" | "scheduled" | "closed" | "disabled"
          waitlistOpen: boolean
          status: "active" | "cancelled"  // Management payloads only.
          registrationCount: integer  // Management payloads only.
        }
      ]
      organizer:
        {
          name: string  // nullable
          contactEmail: string  // nullable
          url: string  // nullable
          logo: string  // nullable
        }
      shareUrl: string  // nullable · Rich-share link (`/s/<eventId>`) once the company sets its events page URL.
      timezone: string  // nullable · IANA zone the event's wall-clock times are meant in (account-level). Datetimes stay UTC instants.
      doorsOpenMins: integer  // nullable
      minAge: integer  // nullable
      parking: "free" | "paid" | "none"  // nullable
      captchaSiteKey: string  // nullable · Tenant-configured bot-protection site key for `captchaProvider`. When present, browser registrations must include a verified captchaToken (the widget handles this automatically).
      captchaProvider: "turnstile" | "recaptcha_v2" | "recaptcha_v3"  // nullable · Which provider `captchaSiteKey` belongs to: Cloudflare Turnstile, Google reCAPTCHA v2 ("I’m not a robot" checkbox) or reCAPTCHA v3 (invisible; execute with action `register`). Null when bot protection is off.
    }
  ]
  total: integer
  limit: integer  // nullable
  offset: integer
  languages: string[]  // The organizer's languages (BCP-47), default first.
}

post/v1/eventssk_ only

Create event (draft)
Request body
{
  title: string
  description: string  // nullable
  descriptionBlocks: [  // optional
    {
      id: string  // required
      type: "text" | "image" | "video" | "faq" | "lineup" | "agenda"  // required
      text: string
      url: string
      urls: string[]
      alt: string  // nullable
      layout: "full" | "text-left" | "text-right"
      provider: "youtube" | "vimeo"
      videoId: string
      items: object[]
    }
  ]
  location: string  // nullable
  startsAt: string
  endsAt: string  // nullable
  capacity: integer  // nullable
  category: string  // nullable
  tags: string[]
  status: "draft" | "published" | "cancelled"
  publishStartsAt: string  // nullable
  publishEndsAt: string  // nullable
  registrationEnabled: boolean
  registrationOpensAt: string  // nullable
  registrationClosesAt: string  // nullable
  waitlistEnabled: boolean
  waitlistLimit: integer  // nullable
  doorsOpenMins: integer  // nullable
  minAge: integer  // nullable
  parking: "free" | "paid" | "none"  // nullable
  organizerName: string  // nullable
  contactEmail: string  // nullable
  organizerUrl: string  // nullable
  organizerLogo: string  // nullable
  confirmationMessage: string  // nullable · Per-event [event_message] paragraph in confirmation emails.
  reminderMessage: string  // nullable
  customFields: [  // optional
    {
      key: string  // required
      label: string  // required
      type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox"  // required
      required: boolean
      helpText: string  // nullable
      options: [  // optional
        {
          value: string
          label: string
        }
      ]
    }
  ]
  occurrences: [  // optional
    {
      id: string
      startsAt: string
      endsAt: string  // nullable
      capacity: integer  // nullable · Per-date override; null = event default.
      spotsLeft: integer  // nullable
      registrationStatus: "open" | "scheduled" | "closed" | "disabled"
      waitlistOpen: boolean
      status: "active" | "cancelled"  // Management payloads only.
      registrationCount: integer  // Management payloads only.
    }
  ]
  recurrence: string  // nullable · Free-form pattern JSON the dashboard uses to regenerate the list.
  translations: object
}
Responses
201

Created.

{
  event:
    {
      id: string
      title: string
      description: string  // nullable · Plain-text card summary.
      descriptionBlocks: [  // optional
        {
          id: string  // required
          type: "text" | "image" | "video" | "faq" | "lineup" | "agenda"  // required
          text: string
          url: string
          urls: string[]
          alt: string  // nullable
          layout: "full" | "text-left" | "text-right"
          provider: "youtube" | "vimeo"
          videoId: string
          items: object[]
        }
      ]
      location: string  // nullable
      startsAt: string  // For recurring events, the NEXT upcoming date.
      endsAt: string  // nullable
      capacity: integer  // nullable · Recurring events: public value is the series total over upcoming dates.
      spotsLeft: integer  // nullable · null = unlimited. Reported as 0 while a waitlist queue holds freed spots.
      category: string  // nullable · Stable slug.
      categoryLabel: string  // nullable · Localized display label.
      tags: string[]  // Stable slugs.
      tagLabels: [  // optional
        {
          slug: string
          label: string
        }
      ]
      bannerUrl: string  // nullable
      thumbnailUrl: string  // nullable
      customFields: [  // optional
        {
          key: string  // required
          label: string  // required
          type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox"  // required
          required: boolean
          helpText: string  // nullable
          options: [  // optional
            {
              value: string
              label: string
            }
          ]
        }
      ]
      registrationStatus: "open" | "scheduled" | "closed" | "disabled"
      registrationOpensAt: string  // nullable
      registrationClosesAt: string  // nullable
      waitlistOpen: boolean
      recurring: boolean
      nextOccurrenceAt: string  // nullable
      occurrences: [  // optional
        {
          id: string
          startsAt: string
          endsAt: string  // nullable
          capacity: integer  // nullable · Per-date override; null = event default.
          spotsLeft: integer  // nullable
          registrationStatus: "open" | "scheduled" | "closed" | "disabled"
          waitlistOpen: boolean
          status: "active" | "cancelled"  // Management payloads only.
          registrationCount: integer  // Management payloads only.
        }
      ]
      organizer:
        {
          name: string  // nullable
          contactEmail: string  // nullable
          url: string  // nullable
          logo: string  // nullable
        }
      shareUrl: string  // nullable · Rich-share link (`/s/<eventId>`) once the company sets its events page URL.
      timezone: string  // nullable · IANA zone the event's wall-clock times are meant in (account-level). Datetimes stay UTC instants.
      doorsOpenMins: integer  // nullable
      minAge: integer  // nullable
      parking: "free" | "paid" | "none"  // nullable
      captchaSiteKey: string  // nullable · Tenant-configured bot-protection site key for `captchaProvider`. When present, browser registrations must include a verified captchaToken (the widget handles this automatically).
      captchaProvider: "turnstile" | "recaptcha_v2" | "recaptcha_v3"  // nullable · Which provider `captchaSiteKey` belongs to: Cloudflare Turnstile, Google reCAPTCHA v2 ("I’m not a robot" checkbox) or reCAPTCHA v3 (invisible; execute with action `register`). Null when bot protection is off.
    }
}
409

plan_limit / invalid_locale.

{
  error: string  // required · Stable machine-readable code.
  message: string  // Human-readable; may change.
}

get/v1/events/{id}pk_ or sk_

Fetch one event
Parameters
NameInType
idpath string
langquery string

BCP-47 locale for localized labels/content (e.g. zh-Hant).

Responses
200

The event.

{
  event:
    {
      id: string
      title: string
      description: string  // nullable · Plain-text card summary.
      descriptionBlocks: [  // optional
        {
          id: string  // required
          type: "text" | "image" | "video" | "faq" | "lineup" | "agenda"  // required
          text: string
          url: string
          urls: string[]
          alt: string  // nullable
          layout: "full" | "text-left" | "text-right"
          provider: "youtube" | "vimeo"
          videoId: string
          items: object[]
        }
      ]
      location: string  // nullable
      startsAt: string  // For recurring events, the NEXT upcoming date.
      endsAt: string  // nullable
      capacity: integer  // nullable · Recurring events: public value is the series total over upcoming dates.
      spotsLeft: integer  // nullable · null = unlimited. Reported as 0 while a waitlist queue holds freed spots.
      category: string  // nullable · Stable slug.
      categoryLabel: string  // nullable · Localized display label.
      tags: string[]  // Stable slugs.
      tagLabels: [  // optional
        {
          slug: string
          label: string
        }
      ]
      bannerUrl: string  // nullable
      thumbnailUrl: string  // nullable
      customFields: [  // optional
        {
          key: string  // required
          label: string  // required
          type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox"  // required
          required: boolean
          helpText: string  // nullable
          options: [  // optional
            {
              value: string
              label: string
            }
          ]
        }
      ]
      registrationStatus: "open" | "scheduled" | "closed" | "disabled"
      registrationOpensAt: string  // nullable
      registrationClosesAt: string  // nullable
      waitlistOpen: boolean
      recurring: boolean
      nextOccurrenceAt: string  // nullable
      occurrences: [  // optional
        {
          id: string
          startsAt: string
          endsAt: string  // nullable
          capacity: integer  // nullable · Per-date override; null = event default.
          spotsLeft: integer  // nullable
          registrationStatus: "open" | "scheduled" | "closed" | "disabled"
          waitlistOpen: boolean
          status: "active" | "cancelled"  // Management payloads only.
          registrationCount: integer  // Management payloads only.
        }
      ]
      organizer:
        {
          name: string  // nullable
          contactEmail: string  // nullable
          url: string  // nullable
          logo: string  // nullable
        }
      shareUrl: string  // nullable · Rich-share link (`/s/<eventId>`) once the company sets its events page URL.
      timezone: string  // nullable · IANA zone the event's wall-clock times are meant in (account-level). Datetimes stay UTC instants.
      doorsOpenMins: integer  // nullable
      minAge: integer  // nullable
      parking: "free" | "paid" | "none"  // nullable
      captchaSiteKey: string  // nullable · Tenant-configured bot-protection site key for `captchaProvider`. When present, browser registrations must include a verified captchaToken (the widget handles this automatically).
      captchaProvider: "turnstile" | "recaptcha_v2" | "recaptcha_v3"  // nullable · Which provider `captchaSiteKey` belongs to: Cloudflare Turnstile, Google reCAPTCHA v2 ("I’m not a robot" checkbox) or reCAPTCHA v3 (invisible; execute with action `register`). Null when bot protection is off.
    }
}
404

Not found, unpublished, or outside its publish window (publishable view).

patch/v1/events/{id}sk_ only

Update event

Partial update; also flips status (draft → published ⇄ cancelled). Plan limits are enforced on publish and on custom-field counts (409 plan_limit). On paid plans, publishing also needs the account’s own SMTP set up and test-sent (409 smtp_required).

Parameters
NameInType
idpath string
Request body
{
  title: string
  description: string  // nullable
  descriptionBlocks: [  // optional
    {
      id: string  // required
      type: "text" | "image" | "video" | "faq" | "lineup" | "agenda"  // required
      text: string
      url: string
      urls: string[]
      alt: string  // nullable
      layout: "full" | "text-left" | "text-right"
      provider: "youtube" | "vimeo"
      videoId: string
      items: object[]
    }
  ]
  location: string  // nullable
  startsAt: string
  endsAt: string  // nullable
  capacity: integer  // nullable
  category: string  // nullable
  tags: string[]
  status: "draft" | "published" | "cancelled"
  publishStartsAt: string  // nullable
  publishEndsAt: string  // nullable
  registrationEnabled: boolean
  registrationOpensAt: string  // nullable
  registrationClosesAt: string  // nullable
  waitlistEnabled: boolean
  waitlistLimit: integer  // nullable
  doorsOpenMins: integer  // nullable
  minAge: integer  // nullable
  parking: "free" | "paid" | "none"  // nullable
  organizerName: string  // nullable
  contactEmail: string  // nullable
  organizerUrl: string  // nullable
  organizerLogo: string  // nullable
  confirmationMessage: string  // nullable · Per-event [event_message] paragraph in confirmation emails.
  reminderMessage: string  // nullable
  customFields: [  // optional
    {
      key: string  // required
      label: string  // required
      type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox"  // required
      required: boolean
      helpText: string  // nullable
      options: [  // optional
        {
          value: string
          label: string
        }
      ]
    }
  ]
  occurrences: [  // optional
    {
      id: string
      startsAt: string
      endsAt: string  // nullable
      capacity: integer  // nullable · Per-date override; null = event default.
      spotsLeft: integer  // nullable
      registrationStatus: "open" | "scheduled" | "closed" | "disabled"
      waitlistOpen: boolean
      status: "active" | "cancelled"  // Management payloads only.
      registrationCount: integer  // Management payloads only.
    }
  ]
  recurrence: string  // nullable · Free-form pattern JSON the dashboard uses to regenerate the list.
  translations: object
}
Responses
200

Updated event (management shape).

409

plan_limit / smtp_required / invalid_locale.

{
  error: string  // required · Stable machine-readable code.
  message: string  // Human-readable; may change.
}

delete/v1/events/{id}sk_ only

Delete event

Blocked with 409 while registrations exist — cancel the event instead. Reclaims uploaded images.

Parameters
NameInType
idpath string
Responses
204

Deleted.

409

Has registrations.

post/v1/events/{id}/viewspk_ or sk_

Count a detail view

Fire-and-forget, PII-free per-day counter (the widget calls this when a visitor opens an event's detail). No body.

Parameters
NameInType
idpath string
Responses
204

Counted.

Registrations & check-in

Registration submission is public (publishable key); attendee lists, cancel/reactivate/promote, and check-in need the secret key.

get/v1/events/{id}/registrationssk_ only

List an event's registrations

Contains PII — management only. Ordered oldest first.

Parameters
NameInType
idpath string
limitquery integer

Page size. Omit (with offset) for the full list.

offsetquery integer

Rows to skip. Page with offset += limit until offset >= total.

statusquery confirmed | waitlisted | cancelled
Responses
200

Registrations with paging metadata.

{
  registrations: [  // optional
    {
      id: string
      eventId: string
      name: string
      email: string
      answers: object  // nullable · Custom-field key → canonical option value(s); multiselect joins with ", "; checkbox stores "yes".
      status: "confirmed" | "waitlisted" | "cancelled"
      locale: string  // nullable
      occurrenceId: string  // nullable
      occurrenceStartsAt: string  // nullable
      ticketUrl: string  // nullable · Hosted QR ticket page; the embedded token is the credential.
      checkedInAt: string  // nullable
      createdAt: string
    }
  ]
  total: integer
  limit: integer  // nullable
  offset: integer
}

post/v1/events/{id}/registrationspk_ or sk_

Register an attendee

Recurring events require occurrenceId (one registration per email per date). When the event/date is full but waitlistOpen is true, the same request succeeds with status: "waitlisted". Never send a website field — it is a bot honeypot.

Parameters
NameInType
idpath string
Request body
{
  name: string  // required
  email: string  // required
  locale: string  // Language of the attendee's confirmation/reminder emails and ticket page.
  occurrenceId: string  // Required for recurring events.
  answers: object  // Custom-field key → canonical option value(s).
  captchaToken: string  // Bot-protection token from the event’s `captchaProvider` (Turnstile, or reCAPTCHA v2/v3 — for v3 executed with action `register`) — required for publishable-key requests when the event’s captchaSiteKey is set. Secret-key calls are never challenged.
}
Responses
201

Registered (or waitlisted).

{
  registration:
    {
      id: string
      eventId: string
      name: string
      email: string
      answers: object  // nullable · Custom-field key → canonical option value(s); multiselect joins with ", "; checkbox stores "yes".
      status: "confirmed" | "waitlisted" | "cancelled"
      locale: string  // nullable
      occurrenceId: string  // nullable
      occurrenceStartsAt: string  // nullable
      ticketUrl: string  // nullable · Hosted QR ticket page; the embedded token is the credential.
      checkedInAt: string  // nullable
      createdAt: string
    }
}
400

invalid_request / invalid_answers (with per-field messages) / captcha_failed.

409

already_registered / sold_out / registration_closed / plan_limit / trial_expired / plan_expired (the trial or plan period has ended — registrations pause until a plan is chosen or renewed).

post/v1/events/{id}/registrations/exportsk_ only

Password-protected Excel export

Real Office AES encryption; includes cancelled records and all custom-field columns. Password: ≥8 chars with a letter and a number.

Parameters
NameInType
idpath string
Request body
{
  password: string  // required
}
Responses
200

Encrypted .xlsx file.

post/v1/registrations/{id}/cancelsk_ only

Cancel a registration

Frees the spot — but never auto-promotes: freed spots are held for the waitlist queue until you promote someone.

Parameters
NameInType
idpath string
Responses
200

Cancelled registration.

post/v1/registrations/{id}/reactivatesk_ only

Restore a cancelled registration

Capacity is re-checked — restore can't oversell (409 sold_out).

Parameters
NameInType
idpath string
Responses
200

Restored.

409

sold_out.

post/v1/registrations/{id}/promotesk_ only

Promote a waitlisted registration

The ONLY way waitlisted becomes confirmed; the attendee gets the standard confirmation email with their ticket. Capacity re-checked.

Parameters
NameInType
idpath string
Responses
200

Promoted.

409

sold_out.

post/v1/events/{id}/checkinsk_ only

Check in by scanned ticket token

The event is derived from the token server-side and cross-checked against the URL: wrong event → 409 with the ticket's real event name; duplicate scan → 409 with the original check-in time. Other tenants' tokens are indistinguishable from invalid ones.

Parameters
NameInType
idpath string
Request body
{
  token: string  // required
}
Responses
200

Checked in.

409

Wrong event or duplicate scan.

post/v1/registrations/{id}/checkinsk_ only

Check in by registration id (search-based flow)
Parameters
NameInType
idpath string
Responses
200

Checked in.

post/v1/registrations/{id}/undo-checkinsk_ only

Undo a mistaken check-in
Parameters
NameInType
idpath string
Responses
200

Undone.

Tickets

Token-authenticated — the ticket URL's token *is* the credential; no API key.

get/v1/tickets/{token}no auth

Ticket details

Attendee name, status, checkedInAt, locale, availableLocales, and the event (title/times/location localized, bannerUrl, organizer). Build custom ticket pages from this plus the QR endpoint.

Parameters
NameInType
tokenpath string
langquery string

BCP-47 locale for localized labels/content (e.g. zh-Hant).

Responses
200

Ticket payload.

404

Unknown or erased token.

get/v1/tickets/{token}/qr.svgno auth

Ticket QR image (SVG)

Encodes the bare token — scannable by the check-in endpoint.

Parameters
NameInType
tokenpath string
Responses
200

SVG image.

Categories & tags

Company categories (plus the platform's general set) and tags. Slugs are permanent; labels translate.

get/v1/categoriespk_ or sk_

List categories

Company categories plus the platform's general set. Management view adds full per-language label maps.

Parameters
NameInType
langquery string

BCP-47 locale for localized labels/content (e.g. zh-Hant).

Responses
200

Categories.

{
  categories: [  // optional
    {
      slug: string  // Permanent identifier, derived from the default-language label at creation.
      label: string  // Localized for the requested `lang`.
      labels: object  // Full per-language map (management view).
    }
  ]
}

post/v1/categoriessk_ only

Create category
Request body
{
  labels: object
}
Responses
201

Created; slug derives from the default-language label and never changes.

put/v1/categories/{slug}sk_ only

Relabel/translate a category
Parameters
NameInType
slugpath string
Request body
{
  labels: object
}
Responses
200

Updated; slug stable.

get/v1/tagspk_ or sk_

List tags
Parameters
NameInType
langquery string

BCP-47 locale for localized labels/content (e.g. zh-Hant).

Responses
200

Tags (same model as categories, company-scoped only).

post/v1/tagssk_ only

Create tag
Responses
201

Created.

put/v1/tags/{slug}sk_ only

Relabel/translate a tag
Parameters
NameInType
slugpath string
Responses
200

Updated.

Images

Raw-body uploads — JPEG/PNG/WebP up to 10 MB, validated by magic bytes.

put/v1/events/{id}/images/{kind}sk_ only

Upload banner or thumbnail

Raw image body (JPEG/PNG/WebP, up to 10 MB, magic-byte validated). Banner is 3:1 (1500×500 recommended), thumbnail square (600×600). Replacing reclaims the old file.

Parameters
NameInType
idpath string
kindpath banner | thumbnail
Request body
Raw image bytes (image/jpeg, image/png, image/webp).
Responses
200

Stored; returns the event with the new URL.

delete/v1/events/{id}/images/{kind}sk_ only

Remove banner or thumbnail
Parameters
NameInType
idpath string
kindpath banner | thumbnail
Responses
200

Removed.

post/v1/images/descriptionsk_ only

Upload a content image

Raw image body → { "url": "/uploads/…" } for use in description blocks, lineup photos, or per-event organizer logos. Uploads nothing ends up referencing are swept after ~24h.

Request body
Raw image bytes (image/jpeg).
Responses
200

{ url }.

Broadcasts

"Message attendees" — paid plans, metered by monthly recipient-message quota.

post/v1/events/{id}/broadcastsk_ only

Message all confirmed attendees

Shortcodes render per recipient in the language each attendee registered in. 409 plan_limit when the plan lacks the feature or the monthly recipient-message quota can't cover the send.

Parameters
NameInType
idpath string
Request body
{
  subject: string  // required
  message: string  // required
}
Responses
200

Send accepted; history records per-recipient status.

409

plan_limit.

post/v1/events/{id}/broadcast-testsk_ only

Test a broadcast (mails only you)

Renders with sample data — no quota use, no history entry.

Parameters
NameInType
idpath string
Responses
200

Sent to the caller.

get/v1/broadcast-quotask_ only

Monthly recipient-message quota
Responses
200

{ limit, used, remaining }.

get/v1/events/{id}/broadcastssk_ only

Broadcast history for an event
Parameters
NameInType
idpath string
Responses
200

Broadcasts with counts.

get/v1/broadcasts/{id}/recipientssk_ only

Per-recipient results of a broadcast
Parameters
NameInType
idpath string
Responses
200

Recipients with sent/failed status.

Email templates

Per-company confirmation/reminder templates with shortcodes: [name] [email] [ticket_url] [event_title] [event_date] [event_time] [event_location] [event_message] [company_name].

get/v1/email-templatessk_ only

List effective templates

Optional ?locale= for per-language templates; localized built-in defaults exist for en / zh-Hant / zh-Hans / ja.

Parameters
NameInType
localequery string
Responses
200

Templates.

put/v1/email-templates/{type}sk_ only

Save a custom template

type is confirmation or reminder. Unknown shortcodes are rejected (400 unknown_placeholders).

Parameters
NameInType
typepath confirmation | reminder
localequery string
Responses
200

Saved.

delete/v1/email-templates/{type}sk_ only

Revert to the built-in default
Parameters
NameInType
typepath confirmation | reminder
Responses
200

Reverted.

post/v1/email-templates/{type}/testsk_ only

Mail yourself a rendered sample
Parameters
NameInType
typepath confirmation | reminder
Responses
200

Sent to the caller.

post/v1/events/{id}/email-testsk_ only

Test an event's emails

Body: { type, message?, locale? } — renders the event's confirmation/reminder with sample attendee data and mails only the caller.

Parameters
NameInType
idpath string
Responses
200

Sent to the caller.

Webhooks

HMAC-SHA256-signed deliveries with retries. See docs/WEBHOOKS.md for verification code.

get/v1/webhookssk_ only

List webhook endpoints
Responses
200

Endpoints (plan-limited: free 1 / pro 5).

post/v1/webhookssk_ only

Create a webhook endpoint

http(s) URLs only; hostnames resolving to private ranges are rejected (SSRF guard). The whsec_… signing secret is returned once.

Request body
{
  url: string  // required
  events: string[]  // required
}
Responses
201

Created.

{
  webhook:
    {
      id: string
      url: string
      events: string[]  // Subscribed types, e.g. event.published, registration.created.
      enabled: boolean  // Auto-disabled after 10 consecutive failures (owner emailed).
      secret: string  // whsec_… signing secret — returned once at creation.
      createdAt: string
    }
}

patch/v1/webhooks/{id}sk_ only

Update endpoint (url / events / enabled)
Parameters
NameInType
idpath string
Responses
200

Updated.

delete/v1/webhooks/{id}sk_ only

Delete endpoint
Parameters
NameInType
idpath string
Responses
200

Deleted.

post/v1/webhooks/{id}/testsk_ only

Synchronous test ping
Parameters
NameInType
idpath string
Responses
200

Delivery attempt result.

post/v1/webhooks/{id}/push-allsk_ only

Queue a full snapshot (sync.push)

Initial sync / recovery: queues the complete current state to the endpoint.

Parameters
NameInType
idpath string
Responses
200

Queued.

get/v1/webhooks/{id}/deliveriessk_ only

Delivery log
Parameters
NameInType
idpath string
Responses
200

Recent deliveries with status/attempts.

post/v1/webhooks/deliveries/{id}/redeliversk_ only

Redeliver one delivery
Parameters
NameInType
idpath string
Responses
200

Requeued.

Reports

Registration/view analytics.

get/v1/reports/overviewsk_ only

Registrations & views overview

Per-day registrations/views series (timezone-correct local buckets) and per-event confirmed/checked-in/attendance/fill/view counts.

Parameters
NameInType
daysquery 14 | 30 | 90
Responses
200

Report payload.

GDPR

Right-to-erasure execution.

post/v1/gdpr/erase-attendeesk_ only

Erase an attendee (right to erasure)

Anonymizes every registration and broadcast-recipient record for the email across your account: identity, answers, and ticket QR are gone; counts and statistics stay truthful; the email may register again. Irreversible.

Request body
{
  email: string  // required
}
Responses
200

{ erased: { registrations, broadcastRecipients } }.

404

No records for that email.

Platform

Health and utility endpoints.

get/v1/healthno auth

Health check
Responses
200

OK

No endpoints match that filter.