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

---

Zaps

Endpoints to interact with Zaps

Operations

GET/api/v2/zapsPOST/api/v2/zapsGET/api/v2/zaps/{id}DELETE/api/v2/zaps/{id}PATCH/api/v2/zaps/{id}POST/api/v2/zaps/bulk-delete

---

List zaps

GET

/api/v2/zaps

Returns a list of zaps

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Zap list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/zaps

Playground

Authorization

bearerAuth

Samples

---

Create zap

POST

/api/v2/zaps

Create a new zap

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created zap

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/zaps

Playground

Authorization

bearerAuth

Body

Samples

---

Get zap by ID

GET

/api/v2/zaps/{id}

Returns a single zap by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Zap ID

Type

integer

Required

Format

"int64"

Responses

Zap object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/zaps/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete zap

DELETE

/api/v2/zaps/{id}

Delete a zap

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Zap ID

Type

integer

Required

Format

"int64"

Responses

Zap deleted successfully

DELETE

/api/v2/zaps/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update zap

PATCH

/api/v2/zaps/{id}

Update an existing zap

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Zap ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated zap

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/zaps/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple zaps

POST

/api/v2/zaps/bulk-delete

Deletes multiple zaps

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Zaps deleted successfully

POST

/api/v2/zaps/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI