v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

ExportJob

Generic async CSV export job management (list, download, delete).

Operations

GET/api/v2/export/jobsGET/api/v2/export/jobs/{id}DELETE/api/v2/export/jobs/{id}

---

List all async CSV export jobs

GET

/api/v2/export/jobs

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

exportType

Filter by export type prefix (e.g. salesReport-sales).

Type

string

Example"salesReport-sales"

Responses

Export job list

Content-Type

application/json

"string"

GET

/api/v2/export/jobs

Playground

Authorization

bearerAuth

Variables

Key

Value

exportType

Samples

---

Download a completed async export as CSV

GET

/api/v2/export/jobs/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

CSV file download

Content-Type

text/csv

GET

/api/v2/export/jobs/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete an async export job and its S3 file

DELETE

/api/v2/export/jobs/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Job deleted

DELETE

/api/v2/export/jobs/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Powered by VitePress OpenAPI