Skip to main content
GET
/
zones
/
items
Retrieve Zone Items
curl --request GET \
  --url https://api.nuwebgroup.com/v1/zones/items \
  --header 'Authorization: Bearer <token>'
[
  {
    "barcode": "ABCDEFG",
    "nfcId": "0xABCDEFG",
    "isGuest": false,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "lastScannedIn": "2021-11-22T11:59:00.000000Z",
    "lastScannedOut": "2021-11-22T11:59:00.000000Z",
    "createdAt": "2021-11-22T11:59:00.000000Z",
    "updatedAt": "2021-11-22T11:59:00.000000Z",
    "deletedAt": null,
    "orderReference": "RO3PMNGE1N"
  }
]

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

ā€‹
zoneId
integer
required

The ID of the zone to retrieve ticket information on.

ā€‹
scanType
enum<string>

An optional scanning filter.

Available options:
in,
out,
in&out
ā€‹
query
string

Filter items by a search filter - this is compared against the ticket holders full name, email, order reference and barcode

ā€‹
offset
integer

Set a query offset for fetching multiple pages of items

ā€‹
limit
integer

Set a limit on items received - defaults to 100.

ā€‹
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

Response

Successful request to fetch live zone data for an event.

ā€‹
barcode
string
ā€‹
nfcId
string
ā€‹
isGuest
boolean
ā€‹
firstName
string
ā€‹
lastName
string
ā€‹
email
string
ā€‹
lastScannedIn
string
ā€‹
lastScannedOut
string
ā€‹
createdAt
string
ā€‹
updatedAt
string
ā€‹
deletedAt
string
ā€‹
orderReference
string
Example:
[
  {
    "barcode": "ABCDEFG",
    "nfcId": "0xABCDEFG",
    "isGuest": false,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "lastScannedIn": "2021-11-22T11:59:00.000000Z",
    "lastScannedOut": "2021-11-22T11:59:00.000000Z",
    "createdAt": "2021-11-22T11:59:00.000000Z",
    "updatedAt": "2021-11-22T11:59:00.000000Z",
    "deletedAt": null,
    "orderReference": "RO3PMNGE1N"
  }
]