List public events (widget)

Public, unauthenticated feed of published public events across one or more hosts.

Query Parameters

hostsRequiredstring

Comma-separated host IDs (1-10)

pageinteger

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Default: 20Minimum: 1Maximum: 100

searchstring

Maximum length: 200

startBeforestring

Pattern:

"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"

Format: "date-time"

startAfterstring

Pattern:

"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"

Format: "date-time"

sortFieldstring

Value in: "start" | "name"

sortDirectionstring

Value in: "asc" | "desc"

GET/widget/v1/events/

curl -X GET "https://api.3common.com/widget/v1/events/?hosts=string&search=string&startBefore=2019-08-24T14%3A15%3A22Z&startAfter=2019-08-24T14%3A15%3A22Z&sortField=start&sortDirection=asc"

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"
    }
  ],
  "hasMore": true
}

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;
  }[];
  hasMore: boolean;
}

List public events (widget)

Public, unauthenticated feed of published public events across one or more hosts.

Query Parameters

hostsRequiredstring

Comma-separated host IDs (1-10)

pageinteger

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Default: 20Minimum: 1Maximum: 100

searchstring

Maximum length: 200

startBeforestring

Pattern:

"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"

Format: "date-time"

startAfterstring

Pattern:

"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"

Format: "date-time"

sortFieldstring

Value in: "start" | "name"

sortDirectionstring

Value in: "asc" | "desc"

GET/widget/v1/events/

curl -X GET "https://api.3common.com/widget/v1/events/?hosts=string&search=string&startBefore=2019-08-24T14%3A15%3A22Z&startAfter=2019-08-24T14%3A15%3A22Z&sortField=start&sortDirection=asc"

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"
    }
  ],
  "hasMore": true
}

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;
  }[];
  hasMore: boolean;
}