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

---

IntegrationsActiveCampaign

Endpoints to interact with ActiveCampaign integration

Operations

GET/api/v2/integrations/active-campaignPATCH/api/v2/integrations/active-campaignGET/api/v2/integrations/active-campaign/listsDELETE/api/v2/integrations/active-campaign/api-keyDELETE/api/v2/integrations/active-campaign/custom-schemas

---

Get Active Campaign settings

GET

/api/v2/integrations/active-campaign

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Active Campaign settings

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/integrations/active-campaign

Playground

Authorization

bearerAuth

Samples

---

Update Active Campaign settings

PATCH

/api/v2/integrations/active-campaign

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Settings updated successfully

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/integrations/active-campaign

Playground

Authorization

bearerAuth

Body

Samples

---

Search ActiveCampaign lists

GET

/api/v2/integrations/active-campaign/lists

Returns lists from the ActiveCampaign API (v1 api/activeCampaignInterface/searchLists parity). Uses site integration API URL and API key. Optional name filter matches v1 filters[name] query.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

search

Filter lists by name (partial match per ActiveCampaign API)

Type

string

Example"newsletter"

Responses

ActiveCampaign lists

Content-Type

application/json

{

  

"data": [

  

]

}

GET

/api/v2/integrations/active-campaign/lists

Playground

Authorization

bearerAuth

Variables

Key

Value

search

Samples

---

Delete ActiveCampaign API key

DELETE

/api/v2/integrations/active-campaign/api-key

Remove the stored ActiveCampaign API key (v1 settingsActiveCampaign delete-api-key parity).

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

API key deleted; returns updated settings

Content-Type

application/json

{

  

"data": "string"

}

DELETE

/api/v2/integrations/active-campaign/api-key

Playground

Authorization

bearerAuth

Samples

---

Clear ActiveCampaign custom schemas

DELETE

/api/v2/integrations/active-campaign/custom-schemas

Delete ActiveCampaign custom object schemas (v1 settingsActiveCampaign clear-custom-schemas parity).

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Custom schemas cleared

Content-Type

application/json

{

  

"data": {

  

  

"success": true

  

}

}

DELETE

/api/v2/integrations/active-campaign/custom-schemas

Playground

Authorization

bearerAuth

Samples

---

Powered by VitePress OpenAPI