v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Teams

Endpoints to interact with teams

Operations

GET/api/v2/teamsPOST/api/v2/teamsGET/api/v2/teams/{id}DELETE/api/v2/teams/{id}PATCH/api/v2/teams/{id}POST/api/v2/teams/bulk-deletePOST/api/v2/teams/{id}/tickets/bulk-deleteGET/api/v2/team/{id}DELETE/api/v2/team/{id}PATCH/api/v2/team/{id}GET/api/v2/teamPOST/api/v2/teamGET/api/v2/team/{id}/members

---

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

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/teams

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId

_include

Samples

---

Create team

POST

/api/v2/teams

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/teams

Playground

Authorization

bearerAuth

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

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/teams/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

_include

Samples

---

Delete team

DELETE

/api/v2/teams/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Deleted

DELETE

/api/v2/teams/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update team

PATCH

/api/v2/teams/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Request Body

application/json

"string"

Responses

Updated

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/teams/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Bulk delete teams

POST

/api/v2/teams/bulk-delete

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

0

  

]

}

Responses

Deleted

POST

/api/v2/teams/bulk-delete

Playground

Authorization

bearerAuth

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

"string"

Responses

Tickets unassigned

POST

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

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

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

GET

/api/v2/team/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

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

DELETE

/api/v2/team/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

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

{

  

"data": "string"

}

Responses

PATCH

/api/v2/team/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

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

GET

/api/v2/team

Playground

Authorization

bearerAuth

Variables

Key

Value

_limit

_offset

_search

_select

eventId

teamName

teamUrl

captain

created

teamType

fundraisingGoal

anonymous

image

teamText

crowdriseTeamId

captainsTicketId

guid

Samples

---

Create Team

POST

/api/v2/team

Creates a new Team from the POST data

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

POST

/api/v2/team

Playground

Authorization

bearerAuth

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

GET

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

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Powered by VitePress OpenAPI