Confetti API

Appearance

Get Form ​

GET/forms/:id

Retrieve a single form by its ID.

Request ​

js
import Confetti from 'confetti'

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

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

Response ​

ts
interface Form {
  id: number
  name: string
  type: string
  default: boolean
  settings: Record<string, unknown>
}
json
{
  "id": 1,
  "name": "Signup Form",
  "type": "signup",
  "default": true,
  "settings": {}
}
json
{
  "data": {
    "id": 1,
    "type": "form",
    "attributes": {
      "name": "Signup Form",
      "type": "signup",
      "default": true,
      "settings": {}
    }
  }
}