Get public event (widget)

Public, unauthenticated detail for a single published public event, including description blocks and product set (checkout) ID.

Path Parameters

idRequiredstring

GET/widget/v1/events/{id}

curl -X GET "https://api.3common.com/widget/v1/events/string"

Default Response

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "schedule": "Single date",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "multiDayStartTimes": [
      "string"
    ],
    "multiDayEndTimes": [
      "string"
    ],
    "status": "string",
    "minPriceCents": 0,
    "maxPriceCents": 0,
    "minBuyerPriceCents": 0,
    "maxBuyerPriceCents": 0,
    "currency": "string",
    "timeZone": "string",
    "isVirtual": true,
    "location": {
      "address": "string",
      "lat": 0,
      "lng": 0
    },
    "locationPlaceholder": "string",
    "virtualEventLink": "string",
    "image": "string",
    "images": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "customTags": [
      "string"
    ],
    "isCancelled": true,
    "productSetId": "string",
    "description": "string",
    "descriptionBlocks": [
      {
        "type": "text",
        "content": "string",
        "id": 0
      }
    ],
    "language": "string"
  }
}

TypeScript

export interface Response {
  data: {
    id: string;
    name: string;
    schedule: "Single date" | "Multiple dates";
    start: string;
    end?: string;
    multiDayStartTimes?: string[];
    multiDayEndTimes?: string[];
    status: string;
    minPriceCents: number | null;
    maxPriceCents: number | null;
    /**
     * Minimum final price the buyer is charged, including the product's configured service fees, excluding tax. Null if the event has no priced products.
     */
    minBuyerPriceCents: number | null;
    /**
     * Maximum final price the buyer is charged, including the product's configured service fees, excluding tax. Null if the event has no priced products.
     */
    maxBuyerPriceCents: number | null;
    currency: string;
    timeZone?: string;
    isVirtual: boolean;
    location?: {
      address?: string;
      lat?: number;
      lng?: number;
    };
    locationPlaceholder?: string;
    virtualEventLink?: string;
    image?: string;
    images?: string[];
    tags?: string[];
    customTags?: string[];
    isCancelled?: boolean;
    /**
     * Root product set ID used by the widget checkout embed
     */
    productSetId?: string;
    description?: string;
    descriptionBlocks?: {
      type: "text" | "image" | "video";
      content: string;
      id: number;
    }[];
    language?: string;
  };
}