v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

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

---

Organizers

Endpoints to interact with organizers

Operations

GET/api/v2/organizersPOST/api/v2/organizersGET/api/v2/organizers/{id}DELETE/api/v2/organizers/{id}PATCH/api/v2/organizers/{id}POST/api/v2/organizers/bulk-delete

---

List organizers

GET

/api/v2/organizers

Returns a list of organizers

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Organizer list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/organizers

Playground

Authorization

bearerAuth

Samples

---

Create organizer

POST

/api/v2/organizers

Create a new organizer

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created organizer

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/organizers

Playground

Authorization

bearerAuth

Body

Samples

---

Get organizer by ID

GET

/api/v2/organizers/{id}

Returns a single organizer by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Organizer ID

Type

integer

Required

Format

"int64"

Responses

Organizer object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/organizers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete organizer

DELETE

/api/v2/organizers/{id}

Delete an organizer

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Organizer ID

Type

integer

Required

Format

"int64"

Responses

Organizer deleted successfully

DELETE

/api/v2/organizers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update organizer

PATCH

/api/v2/organizers/{id}

Update an existing organizer

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Organizer ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated organizer

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/organizers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple organizers

POST

/api/v2/organizers/bulk-delete

Deletes multiple organizers

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Organizers deleted successfully

POST

/api/v2/organizers/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI