List Events

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "description": "string",
      "descriptionBlocks": [
        {
          "type": "text",
          "content": "string",
          "id": 0
        }
      ],
      "schedule": "Single date",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "multiDayStartTimes": [
        "string"
      ],
      "multiDayEndTimes": [
        "string"
      ],
      "status": "draft",
      "itemsSold": 0,
      "revenueCents": 0,
      "minPriceCents": 0,
      "maxPriceCents": 0,
      "currency": "string",
      "timeZone": "string",
      "isPublic": true,
      "isVirtual": true,
      "location": {
        "address": "string",
        "lat": 0,
        "lng": 0
      },
      "locationPlaceholder": "string",
      "virtualEventLink": "string",
      "venueName": "string",
      "image": "string",
      "images": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "customTags": [
        "string"
      ],
      "contentBlocks": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "language": "string",
      "isCancelled": true,
      "redirectUrl": "string",
      "customTerms": {
        "hasCustomTerms": true,
        "type": "url",
        "url": "string",
        "content": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": true
}

export interface Response {
  data: {
    id?: string;
    name?: string;
    /**
     * 'event', 'booking', 'recurring', or 'multiple'
     */
    type?: string;
    /**
     * Event description as HTML. Only present when descriptionBlocks is empty.
     */
    description?: string;
    /**
     * Rich content blocks for the event description. If present and non-empty, clients should render these instead of the description field.
     * Each block has a type (text: HTML content, image: URL, video: YouTube URL) and content string.
     */
    descriptionBlocks?: {
      type: "text" | "image" | "video";
      content: string;
      id: number;
    }[];
    schedule?: "Single date" | "Multiple dates";
    /**
     * For single-date events the start time; for multi-date the first time slot.
     */
    start?: string;
    /**
     * For single-date events the end time; for multi-date the last time slot.
     */
    end?: string;
    /**
     * All start times for multi-day events
     */
    multiDayStartTimes?: string[];
    /**
     * All end times for multi-day events
     */
    multiDayEndTimes?: string[];
    /**
     * The status of an event.
     * - draft: has not been published
     * - open: published and ticket sales are open
     * - closed: published, ticket sales are closed but the event will proceed as normal
     * - unpublished: was previously published, but is no longer visible
     * - cancelled: published, ticket sales closed, event is cancelled
     * - postponed: published, ticket sales closed, event is postponed
     * - schedule: not yet published, scheduled to be published in the future
     */
    status?: "draft" | "open" | "closed" | "unpublished" | "cancelled" | "postponed" | "schedule";
    /**
     * Total tickets and products sold
     */
    itemsSold?: number;
    /**
     * Total event revenue, in cents
     */
    revenueCents?: number;
    /**
     * Minimum ticket/product price in cents. Does not contain fees.
     */
    minPriceCents?: number | null;
    /**
     * Maximum ticket/product price in cents. Does not contain fees.
     */
    maxPriceCents?: number | null;
    /**
     * Currency code (e.g. USD, CAD)
     */
    currency?: string;
    /**
     * IANA time zone (may be missing for pre-2024 events)
     */
    timeZone?: string;
    /**
     * True if the event is public
     */
    isPublic?: boolean;
    /**
     * True if the event is virtual
     */
    isVirtual?: boolean;
    /**
     * Event location with address and coordinates
     */
    location?: {
      address?: string;
      lat?: number;
      lng?: number;
    };
    /**
     * Placeholder text to link to location
     */
    locationPlaceholder?: string;
    /**
     * Link for virtual access
     */
    virtualEventLink?: string;
    /**
     * Name of the associated seating-chart venue
     */
    venueName?: string;
    /**
     * URL of the event's main image
     */
    image?: string;
    /**
     * Gallery images
     */
    images?: string[];
    /**
     * Tag metadata
     */
    tags?: string[];
    /**
     * Custom tag overlays
     */
    customTags?: string[];
    /**
     * Structured content (FAQs, etc.)
     */
    contentBlocks?: {
      [k: string]: unknown;
    }[];
    /**
     * Event language (e.g. 'en', 'fr')
     */
    language?: string;
    /**
     * Cancellation flag
     */
    isCancelled?: boolean;
    /**
     * Post-checkout URL
     */
    redirectUrl?: string;
    /**
     * Custom checkout conditions
     */
    customTerms?: {
      hasCustomTerms?: boolean;
      type?: "url" | "text";
      url?: string;
      content?: string;
    };
    /**
     * Creation timestamp
     */
    createdAt?: string;
    /**
     * Last update timestamp
     */
    updatedAt?: string;
  }[];
  hasMore: boolean;
}