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

---

Export Profiles

Endpoints to interact with export profiles

Operations

GET/api/v2/export-profile/GET/api/v2/export-profile/{id}GET/api/v2/export-profile/{id}/columnsPOST/api/v2/export-profile/countPOST/api/v2/export-profile/{id}/generate-report

---

GET /api/v2/export-profile/

GET

/api/v2/export-profile/

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

name

Name to match against profiles

Type

string

Responses

GET

/api/v2/export-profile/

Playground

Authorization

bearerAuth

Variables

Key

Value

name

Samples

---

Find Export Profile by ID

GET

/api/v2/export-profile/{id}

Returns a single export profile

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of export profile to return

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/export-profile/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Get the columns of an export profile

GET

/api/v2/export-profile/{id}/columns

Get the columns of an export profile

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of export profile

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/export-profile/{id}/columns

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Get the count of records for a set of filters

POST

/api/v2/export-profile/count

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"utcOffset": 0,

  

"eventIds": [

  

  

0

  

],

  

"includeCancelled": false,

  

"includeHeaders": false,

  

"useUpdatedTime": false,

  

"fromYear": 0,

  

"fromMonth": 0,

  

"fromDay": 0,

  

"fromHour": 0,

  

"fromMinute": 0,

  

"fromSecond": 0,

  

"toYear": 0,

  

"toMonth": 0,

  

"toDay": 0,

  

"toHour": 23,

  

"toMinute": 59,

  

"toSecond": 59,

  

"useUtc": false,

  

"_limit": 0,

  

"_offset": 0

}

Responses

POST

/api/v2/export-profile/count

Playground

Authorization

bearerAuth

Body

Samples

---

Generate a report using an export profile

POST

/api/v2/export-profile/{id}/generate-report

Generates a report using an export profile

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of export profile to use

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

POST

/api/v2/export-profile/{id}/generate-report

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Powered by VitePress OpenAPI