v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

My Account

Endpoints for customer interaction with their account

Operations

GET/api/v2/my-accountPUT/api/v2/my-accountPOST/api/v2/my-accountPATCH/api/v2/my-accountGET/api/v2/my-account/eventGET/api/v2/my-account/ticket-type/{eventId}GET/api/v2/my-account/wave-time/{eventId}GET/api/v2/my-account/ordersGET/api/v2/my-account/payment-processorGET/api/v2/my-account/upgrades/{ticketId}PUT/api/v2/my-account/email

---

Returns the customer's information.

GET

/api/v2/my-account

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

The customer's information

Content-Type

application/json

{

  

"data": "string",

  

"count": 0

}

GET

/api/v2/my-account

Playground

Authorization

bearerAuth

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

{

  

"login": "string",

  

"password": "string"

}

Responses

The customer's auth token and basic account information

Content-Type

application/json

{

  

"count": 0,

  

"data": "string"

}

PUT

/api/v2/my-account

Playground

Authorization

bearerAuth

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

{

  

"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.

POST

/api/v2/my-account

Playground

Authorization

bearerAuth

Body

Samples

---

Update account information.

PATCH

/api/v2/my-account

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"accountNumber": "string",

  

"emailAddress": "string",

  

"useInternationalShippingAddress": true,

  

"useInternationalBillingAddress": true,

  

"primary": "string",

  

"billing": "string"

}

Responses

The account has been updated.

PATCH

/api/v2/my-account

Playground

Authorization

bearerAuth

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.

Content-Type

application/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

  

  

  

}

  

  

}

  

]

}

GET

/api/v2/my-account/event

Playground

Authorization

bearerAuth

Variables

Key

Value

title

search

fromEventStart

toEventStart

return

_limit

_offset

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.

Content-Type

application/json

{

  

"totalCount": 0,

  

"count": 0,

  

"limit": 0,

  

"offset": 0,

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string",

  

  

  

"description": "string",

  

  

  

"ordering": 0,

  

  

  

"price": 0

  

  

}

  

]

}

GET

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

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

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.

Content-Type

application/json

"string"

GET

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

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Samples

---

GET /orders

GET

/api/v2/orders

Get orders

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_include

Include related and additional data. Accepted values: order_total, tickets, purchase_questions

Type

string

Example"order_total,tickets,purchase_questions"

order_status

Filter by order status. Accepted values: refunded, partial, checkedIn, purchased, unpaid

Type

string

Example"purchased,checkedIn"

from

Filter orders created from this datetime (format: Y-m-d H:i)

Type

string

Example"2025-11-05 08:19"

to

Filter orders created up to this datetime (format: Y-m-d H:i)

Type

string

Example"2025-11-05 08:25"

event

Filter by a single event ID

Type

integer

Example2

events

Filter by multiple event IDs (comma-separated)

Type

string

Example"1,2"

ticket_type

Filter by ticket type ID

Type

integer

Example3

min_ticket_price_paid

Filter by minimum ticket price paid

Type

number

Example100

Format

"float"

max_ticket_price_paid

Filter by maximum ticket price paid

Type

number

Example200

Format

"float"

payment_methods

Filter by payment methods (comma-separated). Accepted values: cash,credit,sezzle

Type

string

Example"cash,credit"

shipping_methods

Filter by shipping method IDs (comma-separated)

Type

string

Example"1,2"

affiliate

Filter by affiliate ID

Type

integer

Example286

promo_code

Filter by promo code ID

Type

integer

Example2

promo_code_group

Filter by promo code group name

Type

string

Example"ICS Promo Code"

admin_user

Filter by admin user ID

Type

integer

Example1

purchase_from

Filter by purchase source (comma-separated). Accepted values: boxOffice, frontEnd, backEnd, presale

Type

string

Example"boxOffice,frontEnd"

change_status

Filter by change status (comma-separated). Accepted value: transferred,eventChange,upgraded,claimed,unclaimed,withdrawn

Type

string

Example"eventChange,upgraded"

order_id

Filter by specific order ID

Type

integer

Example42962

ticket_barcode

Filter by ticket barcode

Type

string

Example"75387482648539"

wave_time

Filter by wave time IDs (comma-separated)

Type

string

Example"1,2,3"

last_4

Filter by last 4 digits of payment card

Type

string

Example"4242"

new_customer

Filter by new customer flag (false = returning, true = new)

Type

string

Valid values

"false""true"

Example"false"

ticket_status

Filter by ticket status. Accepted values: purchased, checkedIn, cancelled, refunded

Type

string

Example"purchased,checkedIn"

purchase_with_pass

Filter orders purchased with a pass (true = yes)

Type

string

Valid values

"false""true"

Example"true"

deleted

Include deleted orders (true = include deleted)

Type

string

Valid values

"false""true"

Example"true"

all_and_delete

Include all orders including deleted (true = yes)

Type

string

Valid values

"false""true"

Example"true"

Responses

Order list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/orders

Playground

Authorization

bearerAuth

Variables

Key

Value

_include

order_status

from

to

event

events

ticket_type

min_ticket_price_paid

max_ticket_price_paid

payment_methods

shipping_methods

affiliate

promo_code

promo_code_group

admin_user

purchase_from

change_status

order_id

ticket_barcode

wave_time

last_4

new_customer

ticket_status

purchase_with_pass

deleted

all_and_delete

Samples

---

Returns the account's payment processor.

GET

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

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

The list of events.

Content-Type

application/json

{

  

"count": 0,

  

"data": "string"

}

GET

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

Playground

Authorization

bearerAuth

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.

Content-Type

application/json

"string"

GET

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

Playground

Authorization

bearerAuth

Variables

Key

Value

ticketId*

Samples

---

Sends an email to user.

PUT

/api/v2/my-account/email

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"email": "string",

  

"type": "string"

}

Responses

The email was sent.

PUT

/api/v2/my-account/email

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI