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

---

Event Images

Endpoints to manage event gallery images

Operations

GET/api/v2/events/{eventId}/imagesPOST/api/v2/events/{eventId}/imagesDELETE/api/v2/events/{eventId}/images/{id}POST/api/v2/events/{eventId}/images/bulk-deletePOST/api/v2/events/{eventId}/images/reorder

---

List event gallery images

GET

/api/v2/events/{eventId}/images

Returns all gallery images for an event, ordered by their ordering field

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

Query Parameters

published

Filter by published status

Type

boolean

Responses

List of event images

Content-Type

application/json

{

  

"data": [

  

]

}

GET

/api/v2/events/{eventId}/images

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

published

Samples

---

Upload event gallery image

POST

/api/v2/events/{eventId}/images

Upload a new gallery image for an event. Supports both multipart/form-data and base64 JSON uploads.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

Request Body

object

Image file to upload

Format"binary"

Optional title for the image

Whether the image is published (default: true)

Defaulttrue

Responses

Image uploaded successfully

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/events/{eventId}/images

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Body

image*

title

published

Samples

---

Delete event gallery image

DELETE

/api/v2/events/{eventId}/images/{id}

Delete a single gallery image

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

id*

Image ID

Type

integer

Required

Format

"int64"

Responses

Image deleted successfully

DELETE

/api/v2/events/{eventId}/images/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Samples

---

Bulk delete event gallery images

POST

/api/v2/events/{eventId}/images/bulk-delete

Delete multiple gallery images at once

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

Images deleted successfully

POST

/api/v2/events/{eventId}/images/bulk-delete

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Body

Samples

---

Reorder event gallery images

POST

/api/v2/events/{eventId}/images/reorder

Reorder gallery images by providing ALL image IDs for the event in the desired order. The position in the array determines the new ordering value (0-based). You must include all image IDs - partial updates are not allowed.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event ID

Type

integer

Required

Format

"int64"

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

3,

  

  

  

1,

  

  

  

2

  

  

]

  

]

}

Responses

Images reordered successfully

Content-Type

application/json

{

  

"data": [

  

]

}

POST

/api/v2/events/{eventId}/images/reorder

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Body

Samples

---