Skip to main content
GET
/
event-tickets
Retrieve Event Tickets
curl --request GET \
  --url https://api.nuwebgroup.com/v1/event-tickets \
  --header 'Authorization: Bearer <token>'
{
  "tickets": [
    {
      "id": 1,
      "itemId": 123,
      "eventId": 5,
      "name": "Ticket",
      "description": "Quas fuga odio in fuga enim.",
      "basePrice": 500,
      "totalPrice": 500,
      "resellerFee": 0,
      "processing_fee": 0,
      "totalStock": 500,
      "sold": 0,
      "reserved": 0,
      "validFrom": null,
      "validUntil": "2021-11-22T11:59:00.000000Z",
      "minOrderQuantity": 0,
      "maxOrderQuantity": 99,
      "multiplesOf": 0,
      "hideProcessingFee": false,
      "hideResellerFee": false,
      "currencyId": 1,
      "currencySymbol": "Ā£",
      "currencyCode": "GBP",
      "hideFromBoxOffice": false,
      "hideFromShop": false,
      "hideWhenOffSale": false,
      "hideWhenOutOfStock": false,
      "onSaleFrom": "2021-11-23T10:00:00.000000Z",
      "onSaleUntil": "2021-11-26T17:00:00.000000Z",
      "currentStock": 100,
      "onSale": true,
      "seatingPlanAreas": [
        1,
        2
      ],
      "createdAt": "2021-11-22T11:59:00.000000Z",
      "updatedAt": "2021-11-22T11:59:00.000000Z",
      "deletedAt": null
    }
  ],
  "timeslots": [
    {
      "id": 1,
      "name": "et non consequatur",
      "startAt": "2021-11-22T11:59:00.000000Z",
      "endAt": "2021-11-22T11:59:00.000000Z",
      "tickets": [
        [
          1
        ]
      ]
    }
  ],
  "links": {
    "first": "http://api.willms.com/v1/event-tickets?page=1",
    "last": "http://api.willms.com/v1/event-tickets?page=5",
    "prev": "http://api.willms.com/v1/event-tickets?page=2",
    "next": "http://api.willms.com/v1/event-tickets?page=5",
    "self": "http://api.willms.com/v1/event-tickets?page=3"
  },
  "meta": {
    "total": 50
  }
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
eventId
integer

The event ID you wish to retrieve tickets for. If omitted, tickets for all events will be returned and timeslots will be filtered to those associated with the tickets returned on the current page.

ā€‹
page
integer

The page you wish to retrieve event tickets items. If not specified, by default pagination is handled by offset.

ā€‹
offset
integer

The offset - e.g 2 for listing event tickets starting with the 2nd event ticket. Offset will always take precedence over page.

ā€‹
limit
integer

The number of event tickets to retrieve per page. The maximum (and default) is 25 per page.

ā€‹
lastUpdated
string

Date/Time for retrieving event tickets who's associated database records (sale items, inventory item and pricing) have been updated after the given lastUpdated time. Accepted formats:

  • YYYY-MM-DD HH:MM:SS e.g. 2021-01-01 00:00:00
  • YYYY-MM-DDTHH:mm:ss.SSSSSSZ e.g. 2021-01-01T00:00:00.000000Z
Date formats that do not include the timezone must be in UTC.

ā€‹
withTrashed
enum<string>

Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.

  • true to include deleted records
  • false to exclude deleted records (or leave blank)

Available options:
true,
false
ā€‹
checkAreaAvailability
enum<string>

Indicates whether area ID's returned in tickets.*.seatingPlanAreas should be filtered to only include areas with availability.

  • true to return only areas with availability
  • false (default) to return areas regardless of availability

Available options:
true,
false
ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. saleItems.name,eventTimeslots.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. saleItems.name,eventTimeslots.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successful request to fetch event tickets.

ā€‹
tickets
object[]
ā€‹
allPrices
object[]

All prices for all currencies and sales channels. The salesPointType must be used to determine the correct price to use based on the current sales channel. If there is no price for the current sales channel, the price where sales channel is null should be used, as this is the default that covers all sales channels

ā€‹
timeslots
object[]
ā€‹
links
object
ā€‹
meta
object