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

---

Attendee Questions

Endpoints to manage attendee questions for events.

Operations

GET/api/v2/events/{eventId}/attendee-questionsPOST/api/v2/events/{eventId}/attendee-questionsGET/api/v2/events/{eventId}/attendee-questions/{id}DELETE/api/v2/events/{eventId}/attendee-questions/{id}PATCH/api/v2/events/{eventId}/attendee-questions/{id}POST/api/v2/events/{eventId}/ticket-types/{id}/attendee-questionsPOST/api/v2/events/{eventId}/attendee-questions/bulk-delete

---

List Attendee Questions

GET

/api/v2/events/{eventId}/attendee-questions

Returns a list of attendee question for an event

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

Query Parameters

questionId*

Question ID

Type

integer

Required

Format

"int64"

ticketTypeId*

Ticket Type ID

Type

integer

Required

Format

"int64"

Responses

Attendee Question list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/events/{eventId}/attendee-questions

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

questionId*

ticketTypeId*

Samples

---

Create attendee question

POST

/api/v2/events/{eventId}/attendee-questions

Create a attendee question for an event

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Created attendee question

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/events/{eventId}/attendee-questions

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Body

Samples

---

Get Attendee Question by ID API Endpoint

GET

/api/v2/events/{eventId}/attendee-questions/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

id*

Attendee Question ID

Type

integer

Required

Format

"int64"

Responses

Attendee Question object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/events/{eventId}/attendee-questions/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Samples

---

Delete attendee question

DELETE

/api/v2/events/{eventId}/attendee-questions/{id}

Delete a attendee question

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

id*

Attendee Question ID

Type

integer

Required

Format

"int64"

Responses

Attendee question deleted successfully

DELETE

/api/v2/events/{eventId}/attendee-questions/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Samples

---

Update ordering of attendee question

PATCH

/api/v2/events/{eventId}/attendee-questions/{id}

Update ordering of attendee question

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

id*

Id of the attendee question to update

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated attendee question

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/events/{eventId}/attendee-questions/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Body

Samples

---

Create multiple attendee question

POST

/api/v2/events/{eventId}/ticket-types/{id}/attendee-questions

Create multiple attendee question for an event

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

id*

Ticket type ID

Type

integer

Required

Format

"int64"

Request Body

application/json

{

  

"questionIds": [

  

  

0

  

]

}

Responses

Created multiple attendee question

Content-Type

application/json

{

  

"data": [

  

]

}

POST

/api/v2/events/{eventId}/ticket-types/{id}/attendee-questions

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Body

Samples

---

Delete multiple attendee questions

POST

/api/v2/events/{eventId}/attendee-questions/bulk-delete

Deletes multiple attendee questions

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Attendee Questions deleted successfully

POST

/api/v2/events/{eventId}/attendee-questions/bulk-delete

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Body

Samples

---

Powered by VitePress OpenAPI