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

Data Fields

Data Fields are special extra fields that hold questions the customer can be asked on checkout. DataFields can be applied to tickettypes or globally to events.

Endpoints

The Data Field object

Attributes

_id
Required
string

The ID of the data field

sellerId
Required
string

The ID of the seller of the data field

name
Required
string

The name of the data field

type
Required
string

The type of data field

textnumberselectcheckboxtelcountryemaildatedocumentUpload
slug
Required
string

The slug generated out of name

Optional Attributes

Collapse all
Was this section helpful?
YesNo
Example
{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5
}

Create a Data Field

Payload

type
Required
string

The type of data field

textnumberselectcheckboxtelcountryemaildatedocumentUpload
name
Required
string

Optional Attributes

Collapse all
Responses
201
Created
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
post
/api/data-fields
{
  "title": "string",
  "description": "string",
  "isPersonalData": true,
  "type": "text",
  "options": [
    "string"
  ],
  "maxLength": 10.5,
  "name": "string"
}
Response
application/json
{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5
}

Update a Data Field

Payload

Optional Attributes

Collapse all
Responses
200
OK
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
put
/api/data-fields/{id}
{
  "title": "string",
  "description": "string",
  "isPersonalData": true,
  "options": [
    "string"
  ],
  "maxLength": 10.5
}
Response
application/json
{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5
}

Get a Data Field

Query

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

Was this section helpful?

YesNo
get
/api/data-fields/{id}
Response
application/json
{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "title": "string",
  "isPersonalData": true,
  "description": "string",
  "type": "text",
  "slug": "string",
  "options": [
    "string"
  ],
  "maxLength": 10.5
}

Get all Data Fields

Query

No supported query parameters
Responses
200
OK
401
Unauthorized

Was this section helpful?

YesNo
get
/api/data-fields
Response
application/json
[
  {
    "_id": "string",
    "sellerId": "string",
    "name": "string",
    "title": "string",
    "isPersonalData": true,
    "description": "string",
    "type": "text",
    "slug": "string",
    "options": [
      "string"
    ],
    "maxLength": 10.5
  }
]
PUBLIC

Get all Data Fields by reference

Query

eventId
Optional
string
shopId
Optional
string
ticketTypeId
Optional
string
sellerId
Required
string
checkoutId
Optional
string
scope
Required
string

The scope of the data-fields.

CUSTOMERTICKETTRANSACTIONCHECKOUT
locale
Optional
string

Resolve the data-fields for a specific language

Responses
200
OK
400
Bad Request

Was this section helpful?

YesNo
get
/api/data-fields/resolve
Response
application/json
[
  {
    "_id": "string",
    "name": "string",
    "type": "text",
    "options": [
      "string"
    ],
    "slug": "string",
    "description": "string"
  }
]