List Categories

GET/categories

Retrieve a paginated list of categories.

Parameters

Parameter	Default	Values / Description
page[size]	50	Maximum number of results per page
page[number]	1	Page number

Fields marked with * are required.

Request

JavaScript

import Confetti from 'confetti'

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

const categories = await confetti.categories.findAll({
  page: { size: 10, number: 1 },
})

cURL

curl "https://api.confetti.events/categories" \
  -H "Authorization: apikey your-key"

Response

TypeScript

interface Category {
  id: number
  name: string
  createdAt: Date
  updatedAt: Date
  organisationId: number
}

Formatted (SDK)

[
  {
    "id": 1,
    "name": "My category",
    "createdAt": "2023-02-01T10:27:57.026Z",
    "updatedAt": "2023-06-19T14:45:12.605Z",
    "organisationId": 1
  },
  {
    "id": 1,
    "name": "My category",
    "createdAt": "2023-02-01T10:27:57.026Z",
    "updatedAt": "2023-06-19T14:45:12.605Z",
    "organisationId": 1
  }
]

Raw (JSON:API)

{
  "data": [
    {
      "id": 1,
      "type": "category",
      "attributes": {
        "name": "My category",
        "createdAt": "2023-02-01T10:27:57.026Z",
        "updatedAt": "2023-06-19T14:45:12.605Z",
        "organisationId": 1
      }
    },
    {
      "id": 1,
      "type": "category",
      "attributes": {
        "name": "My category",
        "createdAt": "2023-02-01T10:27:57.026Z",
        "updatedAt": "2023-06-19T14:45:12.605Z",
        "organisationId": 1
      }
    }
  ]
}