HomeAPIGuides
Documentation
General
Introduction
API Keys
Core
Checkout
Coupons
Customers
Events
Invoices
Point of Sale
Products
Purchase Intents
Price Tables
Tickets
Ticket Transfers
Transactions
Vouchers
Data Fields
Sales Channels
Webhooks
Distribution
Distribution API
Seating
Maps
Events
Objects
Reservations
Payment
Gateways
Requests
Payment Methods
Pricing
Dynamic Pricing
JS
Seating.JS
Embed.JS
Apps
Installations
Access Control & Checkin
Scans
Access Control Devices
External Access Controls
Access Lists
Memberships
Transactions
Auth
SSO

Access Lists

Access list represents a list having records (access list entries which represent codes). There are different uses for these list, one of them is that the code can be exchanged to a ticket in access control scenarios (Tap & Go).

Endpoints

The Access List object

Attributes

_id
Required
string

The ID of the access list.

sellerId
Required
string

The ID of the seller of the access list.

name
Required
string

The name of the access list.

Was this section helpful?
YesNo
Example
{
  "_id": "string",
  "sellerId": "string",
  "name": "string"
}

Create an Access List

Payload

name
Required
string

The name of the access list.

Responses
201
Created
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
post
/api/access-lists
{
  "name": "string"
}
Response
application/json
{
  "_id": "string",
  "sellerId": "string",
  "name": "string"
}

Get an Access List

Query

No supported query parameters
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
get
/api/access-lists/{id}
Response
application/json
{
  "_id": "string",
  "sellerId": "string",
  "name": "string"
}

Update an Access List

Payload

name
Required
string

The name of the access list.

Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
put
/api/access-lists/{id}
{
  "name": "string"
}
Response
application/json
{
  "_id": "string",
  "sellerId": "string",
  "name": "string"
}

Get Access Lists

Query

name
Optional
string

The name to filter for.

skip
Optional
number float

The number of objects to skip for the requested result

top
Optional
number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

Responses
200
OK
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
get
/api/access-lists
Response
application/json
{
  "docs": [
    {
      "_id": "string",
      "sellerId": "string",
      "name": "string"
    }
  ],
  "total": 1
}

The Access List Entry object

Attributes

_id
Required
string

The ID of the access list entry.

listId
Required
string

The ID of the access list of the access list entry.

externalCode
Required
string

The external code of the access list entry.

sellerId
Required
string

The ID of the seller of the access list entry.

Optional Attributes

Collapse all
Was this section helpful?
YesNo
Example
{
  "_id": "string",
  "listId": "string",
  "externalCode": "string",
  "customerId": "string",
  "sellerId": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "[email protected]",
  "phone": "string",
  "meta": {}
}

Create an Access List Entry

Payload

externalCode
Required
string

The external code of the access list entry.

Optional Attributes

Collapse all
Responses
201
Created
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
post
/api/access-lists/{listId}/entries
{
  "externalCode": "string",
  "customerId": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "[email protected]",
  "phone": "string",
  "meta": {}
}
Response
application/json
{
  "_id": "string",
  "listId": "string",
  "externalCode": "string",
  "customerId": "string",
  "sellerId": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "[email protected]",
  "phone": "string",
  "meta": {}
}

Get an Access List Entry

Query

No supported query parameters
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
get
/api/access-lists/{listId}/entries/{id}
Response
application/json
{
  "_id": "string",
  "listId": "string",
  "externalCode": "string",
  "customerId": "string",
  "sellerId": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "[email protected]",
  "phone": "string",
  "meta": {}
}

Update an Access List Entry

Payload

externalCode
Required
string

The external code of the access list entry.

Optional Attributes

Collapse all
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
put
/api/access-lists/{listId}/entries/{id}
{
  "externalCode": "string",
  "customerId": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "[email protected]",
  "phone": "string",
  "meta": {}
}
Response
application/json
{
  "_id": "string",
  "listId": "string",
  "externalCode": "string",
  "customerId": "string",
  "sellerId": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "[email protected]",
  "phone": "string",
  "meta": {}
}

Delete an Access List Entry

Query

No supported query parameters
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
delete
/api/access-lists/{listId}/entries/{id}
Response
application/json
{
  "_id": "string",
  "listId": "string",
  "externalCode": "string",
  "customerId": "string",
  "sellerId": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "[email protected]",
  "phone": "string",
  "meta": {}
}

Get all Access List Entries

Query

customerId
Optional
string

The ID of the customer to filter for

externalCode
Optional
string

The external code to filter for

email
Optional
string

The email to filter for

skip
Optional
number float

The number of objects to skip for the requested result

top
Optional
number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

Responses
200
OK
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
get
/api/access-lists/{listId}/entries
Response
application/json
{
  "docs": [
    {
      "_id": "string",
      "listId": "string",
      "externalCode": "string",
      "customerId": "string",
      "sellerId": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "[email protected]",
      "phone": "string",
      "meta": {}
    }
  ],
  "total": 1
}
PUBLIC

Get an Access List Entry's Ticket

A token received by your access device must be specified with each request via the HTTP header. token: ${token}

Query

eventId
Required
string

The ID of the event to get a ticket for

Responses
200
OK
400
Bad Request

Was this section helpful?

YesNo
get
/api/access-lists/entries/{externalCode}/ticket
Response
application/json
{
  "sellerId": "string",
  "name": "string",
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "street": "string",
  "line2": "string",
  "city": "string",
  "postal": "string",
  "state": "string",
  "country": "string",
  "eventId": "string",
  "categoryRef": "string",
  "ticketTypeId": "string",
  "ticketName": "string",
  "categoryName": "string",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "completed": true,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "status": "VALID",
  "secret": "string",
  "barcode": "string",
  "seat": "string",
  "seatingInfo": {
    "_id": "string",
    "_type": 6,
    "categoryId": "string",
    "statusId": "string",
    "name": "string",
    "seatType": "handicapped",
    "sectionName": "string",
    "groupName": "string",
    "rowName": "string",
    "seatName": "string",
    "gate": "string"
  },
  "type": "SINGLE",
  "origin": "yourticket",
  "extraFields": {},
  "deliveryType": "HARD",
  "transactionId": "string",
  "batchCounter": 10.5
}