Skip to content

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

List invites

GET
/api/v2/invites

Get a paginated list of invites

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Query Parameters

limit
Type
integer
Default
25
offset
Type
integer
Default
0
event

Filter by event ID (matches invite eventId)

Type
integer
ticketTypes

Filter by ticket type ID(s) on pivot inviteTypes. Comma- or space-separated IDs match invites that have any of those types (same idea as v1 typeIds IN (...)).

Type
string
Example"9,10"
status

Optional alias for linkUsed: open|redeemed (or 0|1). Ignored if linkUsed is set.

Type
string
Valid values
"open""redeemed""0""1"
inviteGroup

Filter by exact invite group name

Type
string
search

Search across inviteGroup, email, firstName, lastName

Type
string

Responses

A list of invites

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

Playground

Authorization
Variables
Key
Value

Samples


Create invite

POST
/api/v2/invites

Create a new invite. Each invite can have a promoCode or storedValueCode (only one) created and linked at creation time. Email is not sent on create unless the body sets sendEmailOnCreate to true (v1 “Send Email when Invite is Created”).

Authorizations

bearerAuth
Type
HTTP (bearer)

Request Body

application/json
JSON
"string"

Responses

Created invite

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

Playground

Authorization
Body

Samples


List invite groups

GET
/api/v2/invites/invite-groups

Get a paginated list of distinct invite group names from non-deleted invites, sorted alphabetically

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Responses

Paginated distinct invite group names

application/json
JSON
"string"

Playground

Authorization

Samples


Get invite

GET
/api/v2/invites/{id}

Get a single invite by ID

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

id*
Type
integer
Required

Responses

Invite details

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

Playground

Authorization
Variables
Key
Value

Samples


Delete invite

DELETE
/api/v2/invites/{id}

Soft-delete an invite

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

id*
Type
integer
Required

Responses

Invite deleted

Playground

Authorization
Variables
Key
Value

Samples


Update invite

PATCH
/api/v2/invites/{id}

Update an existing invite. promoCode and storedValueCode are not allowed in update.

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

id*
Type
integer
Required

Request Body

application/json
JSON
"string"

Responses

Updated invite

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

Playground

Authorization
Variables
Key
Value
Body

Samples


Send invite email

POST
/api/v2/invites/{id}/send-email

Send the invite email for the given invite

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

id*
Type
integer
Required

Responses

Email sent

Playground

Authorization
Variables
Key
Value

Samples


Bulk delete invites

POST
/api/v2/invites/bulk-delete

Soft-delete multiple invites

Authorizations

bearerAuth
Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"ids": [
  
  
0
  
]
}

Responses

Invites deleted

Playground

Authorization
Body

Samples


Find Invites

GET
/api/v2/invite

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Query Parameters

search

Limit to results with invites matching this string in part of the inviteGroup, email, firstName, lastName or hash

Type
string

Request Body

application/json
JSON
{
  
"id": "12585",
  
"inviteGroup": "Special Race Invites",
  
"types": [
  
],
  
"deleted": "0",
  
"eventId": "101985",
  
"typeId": "1095",
  
"email": "george@acme.com",
  
"firstName": "George",
  
"lastName": "Smith",
  
"linkedPromoCode": "1095",
  
"linkedStoredValueCode": "1908",
  
"hash": "924ca91f4beecbc983ee10876448711a",
  
"_limit": 0,
  
"_offset": 0
}

Responses

Playground

Authorization
Variables
Key
Value
Body

Samples


Create a new Invite

POST
/api/v2/invite

Creates a new invite from the POST data

Authorizations

bearerAuth
Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"id": "12585",
  
"inviteGroup": "Special Race Invites",
  
"types": [
  
],
  
"deleted": "0",
  
"eventId": "101985",
  
"typeId": "1095",
  
"email": "george@acme.com",
  
"firstName": "George",
  
"lastName": "Smith",
  
"linkedPromoCode": "1095",
  
"linkedStoredValueCode": "1908",
  
"hash": "924ca91f4beecbc983ee10876448711a"
}

Responses

Playground

Authorization
Body

Samples


Find Invite by Id

GET
/api/v2/invite/{id}

Returns a single invite

Authorizations

bearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

id*

Id of invite to return

Type
integer
Required
Format
"int64"

Responses

Playground

Authorization
Variables
Key
Value

Samples


Powered by VitePress OpenAPI