Premiere V2 API

Appearance

v12.11.0

V2 Staging API Documentation​

Download OpenAPI Document

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers​

https://v2-staging.tscheckout.comCurrent host

Get tickets​

GET
/api/v2/tickets

Returns a list of tickets

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

event

Filter by event ID

Type
integer
events

Filter by event ID(s). Comma-separated list, e.g. 2,3.

Type
integer
accessEvents

Filter by access to event ID(s) (either by direct access or through access package). Comma-separated list, e.g. 2,3.

Type
integer
teams

Filter by team ID(s). Comma-separated list, e.g. 0,5 for unassigned (0) or assigned to team 5

Type
string
Example"0,5"
ticket_types

Filter by ticket types ID(s). Comma-separated list, e.g. 2,3.

Type
string
Example"2,5"
exclude_process_states

Exclude tickets with these processState values (comma-separated). Use 4 to omit cancelled tickets (valid/sold list).

Type
string
Example"4"
_include

Comma-separated optional expansions: change_status (ticketClaim), ticket_status (ticketRefund), purchaser (nested purchaser contact fields), checkInInfo (scannedTimestamp plus scans: at most one simple scan and zero or more accessPackage scans; each scan includes eventId, eventName, scannedTimestamp)

Type
string
Example"purchaser,checkInInfo"

Responses​

Ticket list

application/json
JSON
{
  
"count": 10,
  
"totalCount": 25,
  
"limit": 50,
  
"offset": 25,
  
"data": [
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Check-in and sold stats for events​

GET
/api/v2/tickets/check-in-stats

Returns aggregate sold ticket count (SUM of ticketTypeSoldCount for types on the given events, same as Event Manager) and checked-in ticket count matching v1 attendee check-in: eligible tickets (not cancelled, transferred, or withdrawn) with processState checked-in or a non-deleted access-package scan for one of the events.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

events*

Comma-separated event IDs (required)

Type
string
Required
Example"1,2,3"

Responses​

Sold and checked-in counts for the requested events

application/json
JSON
{
  
"data": {
  
  
"eventIds": [
  
  
  
0
  
  
],
  
  
"soldTickets": 0,
  
  
"checkedInTickets": 0
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

GET /tickets/{id}​

GET
/api/v2/tickets/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Query Parameters

_include

Comma-separated optional expansions: change_status, ticket_status, purchaser, checkInInfo (same as GET /tickets: scans with eventName + scannedTimestamp)

Type
string
Example"purchaser,checkInInfo"

Responses​

Ticket object

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

DELETE /tickets/{id}​

DELETE
/api/v2/tickets/{id}

Delete ticket by Id

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Responses​

Ticket deleted successfully

Playground​

Authorization
Variables
Key
Value

Samples​

Update ticket​

PATCH
/api/v2/tickets/{id}

Update ticket by Id

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
{
  
"data": {
  
  
"eventId": 1,
  
  
"typeId": 1,
  
  
"teamId": 1,
  
  
"barcode": "30912563916058",
  
  
"bibNumber": "A3455",
  
  
"chipNumber": "30567",
  
  
"externalMembershipId": "string",
  
  
"processState": "string",
  
  
"withdrawnState": "string",
  
  
"price": 100,
  
  
"taxAmount": 0,
  
  
"gratuityAmount": 0,
  
  
"paidUponCheckout": 110,
  
  
"partyMember": "John",
  
  
"partyMemberLastName": "Doetest",
  
  
"emailAddress": "john@example.com",
  
  
"partyMemberBirthMonth": 0,
  
  
"partyMemberBirthDay": 0,
  
  
"partyMemberBirthYear": 0,
  
  
"partyMemberTitle": "string",
  
  
"partyMemberCompany": "Amazing Company",
  
  
"attendeeQuestions": [
  
  
  
{
  
  
  
  
"questionId": 1166,
  
  
  
  
"answerId": 414,
  
  
  
  
"answerText": "M ($10.00)",
  
  
  
  
"dynamicQuantity": 0,
  
  
  
  
"displayText": "M ($10.00)",
  
  
  
  
"sku": "123"
  
  
  
}
  
  
]
  
}
}

Responses​

Updated ticket object

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Get ticket waivers​

GET
/api/v2/tickets/{id}/waivers

Flat list of event/type-required waivers for the ticket, including day-of waivers, with signed status and a timezone-adjusted signed date.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Query Parameters

signedStatus

Filter by signed status

Type
string
Valid values
"signed""unsigned"

Responses​

Ticket waiver list

application/json
JSON
{
  
"data": [
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Check in ticket​

POST
/api/v2/tickets/{id}/check-in

Check in a ticket by ID. Implements attendee check-in parity with v1 (simple or access-package scans) in v2 code. Body must be empty; administrator identity comes from the JWT.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Responses​

Ticket checked in; returns the ticket resource (same as GET /tickets/{id})

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Transfer ticket​

POST
/api/v2/tickets/{id}/transfer

Transfer a ticket to another event and/or ticket type (admin Order Manager parity). When event or type changes, creates a new ticket and marks the original as transferred; otherwise updates attendee info in place.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
"string"

Responses​

Ticket transferred; returns the active ticket resource (new ticket when event/type changed)

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Sign ticket waivers​

POST
/api/v2/tickets/{id}/sign-waivers

Sign one or more waivers for a ticket with a single reusable signature (text, image, and/or SVG). Persists the signature first, then links each unsigned waiver with the current waiver version hash.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
"string"

Responses​

Waivers signed; returns the ticket resource (same as GET /tickets/{id})

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Upload ticket profile photo​

POST
/api/v2/tickets/{id}/profile-photo

Upload attendee profile photo (multipart). Stored as public URL on the ticket.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Request Body​

multipart/form-data
object
Format"binary"

Responses​

Ticket with profilePhoto set

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Delete ticket profile photo​

DELETE
/api/v2/tickets/{id}/profile-photo

Remove stored profile photo URL from the ticket (best-effort delete of public object).

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Ticket Id

Type
integer
Required
Format
"int64"

Responses​

Ticket with profilePhoto cleared

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Delete multiple tickets​

POST
/api/v2/tickets/bulk-delete

Deletes multiple tickets

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"ids": [
  
  
[
  
  
  
1,
  
  
  
2,
  
  
  
3
  
  
]
  
]
}

Responses​

Tickets deleted successfully

Playground​

Authorization
Body

Samples​

GET /api/v2/ticket​

GET
/api/v2/ticket

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

orderId

Limit to tickets in this order

Type
string
eventId

Limit to tickets for this event

Type
string
typeId

Limit to tickets of this type

Type
string
customerId

Limit to tickets for this customer

Type
string
barcode

Limit to tickets matching this barcode

Type
string
search

Limit to tickets matching this search string

Type
string
purchasedFrom

Limit to tickets purchased after this date/time

Type
string
purchasedTo

Limit to tickets purchased before this date/time

Type
string
updatedFrom

Limit to tickets updated after this date/time

Type
string
updatedTo

Limit to tickets updated before this date/time

Type
string
_limit

Limit tickets to this number

Type
integer
Format
"int64"
_offset

Limit tickets to this number

Type
integer
Format
"int64"
_include

Adds additional details to the results. Multiple options can be include seperated by a comma. Supports the following values:

  • costs - Include costs details.
  • refundProtect - Include refund protect information
  • change - Include ticket id of new/old ticket.
  • promoter - Include the ticket's promoter.
  • waveTime - Include the wave time id (if any).
  • waivers - Includes signed waivers attached to the ticket (if any).
  • user - Include user information.
Type
string

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Find Ticket by ID​

GET
/api/v2/ticket/{id}

Returns a single ticket

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Id of ticket to return

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Find Answers for Attendee questions on tickets​

GET
/api/v2/ticket/{ticketId}/answers

Returns all answer records for a ticket

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

ticketId

Id of ticket to return Answers for

Type
integer
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Pull the claim info for a given ticket either by ticketId or (id of the claim record - less likely)​

GET
/api/v2/ticket/{ticketId}/claim-info

Returns true or false for the ticket

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

ticketId

Id of ticket to check

Type
integer
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Find out if a ticket has was sent as a claim or not​

GET
/api/v2/ticket/{id}/is-a-claim

Returns true or false for the ticket

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Id of ticket to check

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Find out if a ticket has been claimed or not​

GET
/api/v2/ticket/{id}/is-claimed

Returns true or false for the ticket

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Id of ticket to check

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Modify the claimant email for a given ticket claim​

POST
/api/v2/ticket/{ticketId}/claimant

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

ticketId

Id of ticket to return Answers for

Type
integer
Format
"int64"

Request Body​

application/json

Responses​

Playground​

Authorization
Variables
Key
Value
Body

Samples​

POST /api/v2/ticket/{ticketId}/claim​

POST
/api/v2/ticket/{ticketId}/claim

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

ticketId

Id of ticket to claim

Type
integer
Format
"int64"

Request Body​

application/json
JSON
{
  
"claimantEmail": "string",
  
"claimantuserId": "string"
}

Responses​

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Check if a bib number is available for a ticket​

GET
/api/v2/ticket/{ticketId}/is-bib-available/{bib}

Returns whether the provided bib is available for the given ticket.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

ticketId*

Ticket ID

Type
integer
Required
Format
"int64"
bib*

Bib number to check

Type
integer
Required
Format
"int64"

Responses​

Bib availability result

application/json
JSON
{
  
"available": "true"
}

Playground​

Authorization
Variables
Key
Value

Samples​

POST /api/v2/ticket/{ticketId}/states​

POST
/api/v2/ticket/{ticketId}/states

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

ticketId

Id of ticket to claim

Type
integer
Format
"int64"

Request Body​

application/json
JSON
{
  
"processState": 0,
  
"transferState": "string",
  
"upgradeState": "string",
  
"deleted": 0
}

Responses​

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI