GET

List Tickets

Retrieves a list of up to 100 tickets, given the provided pagination, filtering & sorting.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions

Learn more about app permissions.

Endpoint

GET

https://www.wixapis.com/events/v1/events/{eventId}/tickets

Path Params

eventIdstringRequired

Event IDs.

Query Params

offsetinteger

Offset. See Pagination.

limitinteger

Number of items to load per page. See Pagination.

orderNumberArray <string>

Order numbers.

ticketNumberArray <string>

Ticket numbers.

searchPhrasestring

Textual search filter - search is performed on "orderFullName", "guestFullName", and "ticketNumber".

orderStatusArray <string>

Order statuses.

fieldsetArray <string>

Set of fields to return in the response. See Fieldsets.

stateArray <string>

Ticket states.

memberIdArray <string>

Site member IDs.

facetArray <string>

Filter facets. See supported facets.

sortstring

Sort order. Defaults to "ticket_number:asc". See supported fields.

contactIdArray <string>

Guest contact IDs.

ticketDefinitionIdArray <string>

Ticket definition IDs.

seatIdArray <string>

Seat IDs.

Response Object

totalinteger

Total tickets matching the given filters.

offsetintegerminimum 0

Offset.

limitintegerminimum 0maximum 100

Limit.

ticketsArray <Ticket>

Tickets.

facetsMap <string, FacetCounts>format map

Facets.

Example shown:List Tickets Example 1

Request

cURL


curl -X GET 'https://www.wixapis.com/events/v1/events/ad18d12e-a6a9-4c17-abfa-6ff119479be2/tickets?limit=10&fieldset=GUEST_DETAILS&fieldset=TICKET_DETAILS&state=PAID' \
-H 'Authorization: <AUTH TOKEN>'

Response

JSON


{
  "total": 2,
  "offset": 0,
  "limit": 10,
  "tickets": [
    {
      "ticketNumber": "FNVL-NIJT-WP021",
      "orderNumber": "FNVL-NIJT-WP",
      "ticketDefinitionId": "d86ffbbd-aa9b-488d-a14b-11752b78e272",
      "name": "Early Bird",
      "price": {
        "amount": "12.34",
        "currency": "USD"
      },
      "free": false,
      "policy": "This is your event ticket. Ticket holders must present their tickets on entry.",
      "orderStatus": "PAID",
      "orderArchived": false,
      "orderFullName": "John Doe",
      "guestDetails": {
        "guestAssigned": false,
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "contactId": "3ef81e9f-106e-408d-a3ee-3df60838acc6"
      },
      "archived": false,
      "anonymized": false,
      "checkInUrl": "https://www.wixevents.com/check-in/FNVL-NIJT-WP021,ad18d12e-a6a9-4c17-abfa-6ff119479be2",
      "ticketPdfUrl": "https://apps.wix.com/events/doc/tickets/Ticket.pdf?request=<TOKEN>"
    },
    {
      "ticketNumber": "FNVL-O7MZ-0Q021",
      "orderNumber": "FNVL-O7MZ-0Q",
      "ticketDefinitionId": "d86ffbbd-aa9b-488d-a14b-11752b78e272",
      "name": "Early Bird",
      "price": {
        "amount": "11.11",
        "currency": "USD"
      },
      "free": false,
      "policy": "This is your event ticket. Ticket holders must present their tickets on entry.",
      "orderStatus": "OFFLINE_PENDING",
      "orderArchived": false,
      "orderFullName": "Jane Doe",
      "guestDetails": {
        "guestAssigned": false,
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane.doe@example.com",
        "contactId": "2b7494bc-550a-47d3-8bba-d22564ae8bdc"
      },
      "archived": false,
      "anonymized": false,
      "checkInUrl": "https://www.wixevents.com/check-in/FNVL-O7MZ-0Q021,ad18d12e-a6a9-4c17-abfa-6ff119479be2",
      "ticketPdfUrl": "https://apps.wix.com/events/doc/tickets/Ticket.pdf?request=<TOKEN>"
    }
  ],
  "facets": {}
}

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?