List Tickets

Lists the host's tickets as the compact projection, filtered and paginated. Sorted by created date ascending (stable bundle order).

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Query Parameters

pageinteger

Page number (0-based, default 0)

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Items per page (default 20, max 500)

Default: 20Minimum: 1Maximum: 500

eventIdstring

Filter to one event

orderIdstring

Filter to one order

productIdstring

Filter to one product

productSetIdstring

Filter to one product set

timeslotIdstring

Filter to one timeslot

typestring

Filter by ticket type

statusstring

true = paid tickets only

refundedstring

true = refunded only; false = non-refunded only

cancelledstring

true = cancelled only

checkedInstring

true = checked-in only

sortDirectionstring

Sort by created date (default: asc)

Value in: "asc" | "desc"

GET/v1/tickets/

curl -X GET "https://api.3common.com/v1/tickets/?eventId=string&orderId=string&productId=string&productSetId=string&timeslotId=string&type=string&status=string&refunded=string&cancelled=string&checkedIn=string&sortDirection=asc" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "id": "string",
      "customerName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "itemName": "string",
      "eventId": "string",
      "eventName": "string",
      "orderId": "string",
      "productId": "string",
      "timeslotId": "string",
      "date": "2019-08-24T14:15:22Z",
      "checkedIn": true,
      "isBoxOffice": true,
      "refunded": true,
      "status": true,
      "type": "string",
      "productType": "string",
      "currency": "string",
      "amount": 0,
      "seatingInformation": {
        "section": "string",
        "sectionId": "string",
        "row": "string",
        "seat": "string",
        "property1": null,
        "property2": null
      },
      "property1": null,
      "property2": null
    }
  ],
  "hasMore": true
}

TypeScript

export interface Response {
  data: {
    /**
     * Ticket ObjectId (used to generate the PDF/QR)
     */
    id: string;
    customerName: string;
    firstName: string;
    lastName: string;
    email: string;
    itemName: string;
    eventId?: string;
    eventName?: string;
    orderId?: string;
    productId?: string;
    timeslotId?: string;
    /**
     * Ticket / event date (ISO 8601)
     */
    date?: string;
    checkedIn?: boolean;
    isBoxOffice?: boolean;
    refunded?: boolean;
    /**
     * True for paid tickets.
     */
    status: boolean;
    type?: string;
    productType?: string;
    currency?: string;
    /**
     * Per-ticket gross, in cents.
     */
    amount: number;
    seatingInformation?: {
      section?: string | number;
      sectionId?: string | number;
      row?: string | number;
      seat?: string | number;
      [k: string]: unknown;
    };
    [k: string]: unknown;
  }[];
  hasMore: boolean;
}