Confetti API

Appearance

Get Ticket Batch ​

GET/ticket-batches/:id

Retrieve a single ticket batch by its ID.

Parameters ​

ParameterDefaultValues / Description
includeform

Request ​

js
import Confetti from 'confetti'

const confetti = new Confetti({ apiKey: 'your-key' })

const ticketBatch = await confetti.ticketBatches.find(1)
sh
curl "https://api.confetti.events/ticket-batches/1" \
  -H "Authorization: apikey your-key"

Response ​

ts
interface TicketBatch {
  id: number
  left: number
  status: string
  name: string
  order: number
  description: string
  promoCode: string
  releasedAt: Date
  closedAt: Date
  price: string
  useCustomVat: boolean
  vatPercentage: number
  limit: number
  sold: number
  reserved: number
  settings: Record<string, unknown>
  startDate: Date
  endDate: Date
  createdAt: Date
  updatedAt: Date
  eventId: number
  linkedTicketBatchId: number
  formId: number
  payoutId: number
}
json
{
  "left": 20,
  "status": "available",
  "id": 1,
  "name": "My ticket batch",
  "order": 1,
  "description": null,
  "promoCode": null,
  "releasedAt": null,
  "closedAt": null,
  "price": "0",
  "useCustomVat": false,
  "vatPercentage": null,
  "limit": 20,
  "sold": 0,
  "reserved": 0,
  "settings": {},
  "startDate": null,
  "endDate": null,
  "createdAt": "2023-04-27T03:18:25.468Z",
  "updatedAt": "2023-04-27T03:18:25.468Z",
  "eventId": 5,
  "linkedTicketBatchId": null,
  "formId": null,
  "payoutId": null
}
json
{
  "data": {
    "id": 1,
    "type": "ticketBatch",
    "attributes": {
      "left": 20,
      "status": "available",
      "name": "My ticket batch",
      "order": 1,
      "description": null,
      "promoCode": null,
      "releasedAt": null,
      "closedAt": null,
      "price": "0",
      "useCustomVat": false,
      "vatPercentage": null,
      "limit": 20,
      "sold": 0,
      "reserved": 0,
      "settings": {},
      "startDate": null,
      "endDate": null,
      "createdAt": "2023-04-27T03:18:25.468Z",
      "updatedAt": "2023-04-27T03:18:25.468Z",
      "eventId": 5,
      "linkedTicketBatchId": null,
      "formId": null,
      "payoutId": null
    }
  }
}