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

List teams​

GET
/api/v2/teams

List teams with optional search, sort, and includes

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

eventId

Filter by event ID

Type
integer
_include

Comma-separated: tickets, event

Type
string
Example"tickets,event"

Responses​

Paginated team list

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

Playground​

Authorization
Variables
Key
Value

Samples​

Create team​

POST
/api/v2/teams

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Created

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

Playground​

Authorization
Body

Samples​

Get team by ID​

GET
/api/v2/teams/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Query Parameters

_include

Comma-separated: tickets, event

Type
string

Responses​

Team

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

Playground​

Authorization
Variables
Key
Value

Samples​

Delete team​

DELETE
/api/v2/teams/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Responses​

Deleted

Playground​

Authorization
Variables
Key
Value

Samples​

Update team​

PATCH
/api/v2/teams/{id}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Request Body​

application/json
JSON
"string"

Responses​

Updated

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

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Bulk delete teams​

POST
/api/v2/teams/bulk-delete

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

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

Responses​

Deleted

Playground​

Authorization
Body

Samples​

Bulk remove tickets from a team​

POST
/api/v2/teams/{id}/tickets/bulk-delete

Unassigns tickets from the team (sets teamId to 0). If the team captain is removed, captain is cleared.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Request Body​

application/json
JSON
"string"

Responses​

Tickets unassigned

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Export teams as CSV​

GET
/api/v2/teams/export

Downloads a CSV file containing teams matching the given filters (same format as the team manager export).

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

eventId

Filter by event ID

Type
integer

Responses​

CSV file download with team list.

text/csv
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Export team members as CSV​

GET
/api/v2/teams/{id}/members/export

Downloads a CSV file containing team member details (same format as the team manager export).

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Responses​

CSV file download with team member details.

text/csv
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Find Team by Id​

GET
/api/v2/team/{id}

Returns a single Team

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

id

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Delete one Team by Id​

DELETE
/api/v2/team/{id}

Deletes the identified Team

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

id

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Update Team by Id​

PATCH
/api/v2/team/{id}

Updates an existing Team from the PATCH data

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

id

Type
integer
Required
Format
"int64"

Request Body​

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

Responses​

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Find a list of Teams by a set of filters​

GET
/api/v2/team

Returns a list of Teams

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

_limit

Set the max number of objects to return

Type
number
Format
"int64"
_offset

Set the number of objects to ignore before starting

Type
number
Format
"int64"
_search

text string that will search certain text fields

Type
string
_select

comma separated list of items to select ('tickets.*, ticketTypes.name')

Type
string
eventId

eventId

Type
integer
Format
"int64"
teamName

teamName

Type
string
teamUrl

teamUrl

Type
string
captain

captain

Type
integer
Format
"int64"
created

created

Type
integer
Format
"int64"
teamType

teamType

Type
string
fundraisingGoal

fundraisingGoal

Type
integer
Format
"float"
anonymous

anonymous

Type
integer
Format
"int64"
image

image

Type
string
teamText

teamText

Type
string
crowdriseTeamId

crowdriseTeamId

Type
string
captainsTicketId

captainsTicketId

Type
integer
Format
"int64"
guid

guid

Type
string

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Create Team​

POST
/api/v2/team

Creates a new Team from the POST data

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Playground​

Authorization
Body

Samples​

Find Team Members by Id​

GET
/api/v2/team/{id}/members

Returns a a list of members

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

id

Type
integer
Required
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI