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

Returns the customer's information.​

GET
/api/v2/my-account

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

The customer's information

application/json
JSON
{
  
"data": "string",
  
"count": 0
}

Playground​

Authorization

Samples​

Log in to the customer's account. Return's an auth token that can be used with remaining my account end points.​

PUT
/api/v2/my-account

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"login": "string",
  
"password": "string"
}

Responses​

The customer's auth token and basic account information

application/json
JSON
{
  
"count": 0,
  
"data": "string"
}

Playground​

Authorization
Body

Samples​

Create an account. Requires the caller be an admin that is part of the customer group.​

POST
/api/v2/my-account

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"email": "string",
  
"password": "string",
  
"name": "string"
}

Responses​

The account was created. The user will need to verify there email address before they can sign in.

Playground​

Authorization
Body

Samples​

Update account information.​

PATCH
/api/v2/my-account

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"accountNumber": "string",
  
"emailAddress": "string",
  
"useInternationalShippingAddress": true,
  
"useInternationalBillingAddress": true,
  
"primary": "string",
  
"billing": "string"
}

Responses​

The account has been updated.

Playground​

Authorization
Body

Samples​

List of the events the customer has access to.​

GET
/api/v2/my-account/event

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

title

Search text in just the title - must match exactly unless you use a % to match any char

Type
string
search

Search text in Title, Description, Venue, Venue Address - uses wildcard search

Type
string
fromEventStart

Returns events that start after the given date. The date is a unix timestamp.

Type
integer
Default
false
toEventStart

Returns events that start before the given date. The date is a unix timestamp.

Type
integer
Default
false
return

Only return events the match the value. orders - Only return events that the user purchased a ticket for. all - Return all matching events.

Type
string
Default
"all"
_limit

The maximum number of events to return.

Type
integer
_offset

The first event to return.

Type
integer

Responses​

The list of events.

application/json
JSON
{
  
"totalCount": 0,
  
"count": 0,
  
"limit": 0,
  
"offset": 0,
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"title": "string",
  
  
  
"start": "string",
  
  
  
"venue": "string",
  
  
  
"cutOff": "1702378800",
  
  
  
"onSaleDate": "1702278800",
  
  
  
"publishedDate": "",
  
  
  
"published": "",
  
  
  
"hideDate": "0",
  
  
  
"hideTime": "0",
  
  
  
"smallPic": "",
  
  
  
"largePic": "",
  
  
  
"shortDescription": "Super Race Event in San Francisco",
  
  
  
"category": "",
  
  
  
"ordering": "50",
  
  
  
"location": "Central Park",
  
  
  
"sefUrl": "my-event-12-12-2023",
  
  
  
"timezone": "EST or Europe/Paris",
  
  
  
"inventory": {
  
  
  
  
"sold": 0,
  
  
  
  
"total": 0
  
  
  
}
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

List of the ticket types for an event.​

GET
/api/v2/my-account/ticket-type/{eventId}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

eventId*

Id of event to return

Type
integer
Required
Format
"int64"

Responses​

The list of ticket types.

application/json
JSON
{
  
"totalCount": 0,
  
"count": 0,
  
"limit": 0,
  
"offset": 0,
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"ordering": 0,
  
  
  
"price": 0
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

List of the wave times for an event.​

GET
/api/v2/my-account/wave-time/{eventId}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

eventId*

Id of event to return

Type
integer
Required
Format
"int64"

Responses​

The list of wave times.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Returns the list of orders.​

GET
/api/v2/my-account/orders

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

event

The id of the event tickets where purchased for. Supports multiple values separated by a comma.

Type
integer
ticketType

The id of the ticket types that where purchased. Supports multiple values separated by a comma.

Type
integer
fromPurchaseDate

The earliest date the order was purchased.

Type
string
toPurchaseDate

The latest date the order was purchased.

Type
string
_limit

The maximum number of events to return.

Type
integer
_offset

The first event to return.

Type
integer
includeTickets

Set to true to include the ticket details.

Type
boolean
includeTrans

Include the order's transactions.

Type
boolean
includeAnswers

Include any answer's for both the orders and tickets.

Type
boolean

Responses​

The list of events.

application/json
JSON
{
  
"totalCount": 0,
  
"count": 0,
  
"limit": 0,
  
"offset": 0,
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"created": "string",
  
  
  
"purchasedDate": "string",
  
  
  
"status": "string",
  
  
  
"emailAddress": "string",
  
  
  
"purchaser": "string",
  
  
  
"affiliate": "string",
  
  
  
"grandTotal": 0,
  
  
  
"tickets": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"status": "active",
  
  
  
  
  
"name": "string",
  
  
  
  
  
"price": 0,
  
  
  
  
  
"attendee": 0
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"waveTimeId": 0,
  
"teamId": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Returns the account's payment processor.​

GET
/api/v2/my-account/payment-processor

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

The list of events.

application/json
JSON
{
  
"count": 0,
  
"data": "string"
}

Playground​

Authorization

Samples​

Returns the account's payment processor.​

GET
/api/v2/my-account/upgrades/{ticketId}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

ticketId*

Id of the ticket the customer wishes to upgrade.

Type
integer
Required
Format
"int64"

Responses​

The list of events.

application/json
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Sends an email to user.​

PUT
/api/v2/my-account/email

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"email": "string",
  
"type": "string"
}

Responses​

The email was sent.

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI