Skip to content

Introduction

The Confetti API lets you integrate with Confetti — the all-in-one event management platform for event pages, ticket sales, guest lists, communications, and more.

Use the API to build custom integrations, automate workflows, or sync event data with external systems.

Node.js SDK with TypeScript support

The fastest way to get started is with the official Node.js SDK. It ships with built-in TypeScript declarations — you get full autocompletion and type safety out of the box, with zero extra configuration.

Base URL

All requests use the following base URL:

https://api.confetti.events

Authentication

Authenticate by passing your API key in the Authorization header. Generate a key from Workspace → Settings → API & Webhooks in the Confetti dashboard.

js
import Confetti from 'confetti'

const confetti = new Confetti({ apiKey: 'your-key' })
sh
curl "https://api.confetti.events/events" \
  -H "Authorization: apikey your-key"

WARNING

Replace your-key with your actual API key. Keep it secret — never expose it in client-side code.

Response Format

The API follows the JSON:API specification. The Node.js SDK automatically formats responses into plain objects for convenience.

Both the raw JSON:API payload and the formatted SDK response are shown in the code examples throughout this documentation.

Pagination

List endpoints return paginated results:

ParameterDefaultDescription
page[size]50Results per page (max 50)
page[number]1Page to retrieve

Need Help?