Back to APIs

GET data/tickets

Gets tickets from your authorised venue e.g. memberships, passes...

Request Information

data/tickets?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&pageSize={pageSize}

URI Parameters

NameDescriptionTypeAdditional information
startDate

Search start date, based on booking modified date

date

Accepted format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss

endDate

Search end date, based on booking modified date

date

Accepted format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss

pageNumber

Page number

integer

Optional

Default value is 1

pageSize

Number of ticket records returned

integer

Optional

Default value is 100

Response Information

Resource Description

PageOfTicket
NameDescriptionTypeAdditional information
CurrentPage

integer

None.

TotalPages

integer

None.

TotalItems

integer

None.

ItemsPerPage

integer

None.

Items

Collection of Ticket

None.

Response Formats

application/json, text/json

Sample:
{
  "currentPage": 1,
  "totalPages": 2,
  "totalItems": 3,
  "itemsPerPage": 4,
  "items": [
    {
      "ticketId": "sample string 1",
      "customTicketId": "sample string 2",
      "name": "sample string 3",
      "customerId": "sample string 4",
      "productId": "sample string 5",
      "createdDate": "sample string 6",
      "bookingDate": "sample string 7",
      "expiryDate": "sample string 8",
      "productType": "sample string 9",
      "productSubType": "sample string 10",
      "discountIds": [
        "sample string 1",
        "sample string 2"
      ],
      "numberOfRecurringPayments": 1,
      "recurringPaymentFrequency": "Daily"
    },
    {
      "ticketId": "sample string 1",
      "customTicketId": "sample string 2",
      "name": "sample string 3",
      "customerId": "sample string 4",
      "productId": "sample string 5",
      "createdDate": "sample string 6",
      "bookingDate": "sample string 7",
      "expiryDate": "sample string 8",
      "productType": "sample string 9",
      "productSubType": "sample string 10",
      "discountIds": [
        "sample string 1",
        "sample string 2"
      ],
      "numberOfRecurringPayments": 1,
      "recurringPaymentFrequency": "Daily"
    }
  ]
}