Skip to content

List ticket imports​

GET
/api/v2/ticket-imports

Returns a list of ticket imports

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Responses​

Ticket Import list

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

Playground​

Authorization

Samples​


Create ticket import​

POST
/api/v2/ticket-imports

Upload a CSV file and create a draft import.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

multipart/form-data
object

CSV file

Format"binary"
Valid values"update""import""importAndCharge"

Responses​

Ticket import created

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

Playground​

Authorization
Body

Samples​


Get mapping fields​

GET
/api/v2/ticket-imports/mapping-fields

Returns column mapping field options for CSV imports

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

Mapping field options

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

Playground​

Authorization

Samples​


Get ticket import by ID​

GET
/api/v2/ticket-imports/{id}

Returns a single ticket import by ID

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Responses​

Ticket import object

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

Playground​

Authorization
Variables
Key
Value

Samples​


Delete ticket import​

DELETE
/api/v2/ticket-imports/{id}

Removes the CSV file from storage. If status is not completed (e.g. drafting, processing, failed), the ticket import record is also deleted. If status is completed, only the file is removed and the record is kept (s3Key cleared). Returns 400 if the file could not be removed from storage.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Responses​

Ticket import and/or file deleted successfully

Playground​

Authorization
Variables
Key
Value

Samples​


Update ticket import​

PATCH
/api/v2/ticket-imports/{id}

Save column mapping for the import. Allowed only when status is drafting.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Request Body​

application/json
JSON
"string"

Responses​

Ticket import object

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

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Preview ticket import​

GET
/api/v2/ticket-imports/{id}/preview

Returns row count and estimated tickets created/updated without writing

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Responses​

Preview data

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

Playground​

Authorization
Variables
Key
Value

Samples​


Process ticket import​

POST
/api/v2/ticket-imports/{id}/process

Runs the CSV import. Import must be in drafting status with column mapping set.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
integer
Required

Responses​

Ticket import object

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

Playground​

Authorization
Variables
Key
Value

Samples​


Powered by VitePress OpenAPI