Public
Documentation Settings

CookieScript API

CookieScript API Documentation

To get started:

  • Set your token variable in the environment.

  • Explore available endpoints grouped by feature.

AUTHORIZATIONBearer Token
Token

Banners

Banners

Endpoints for managing cookie banners, including listing, creating, updating, duplicating, and deleting banners.

AUTHORIZATIONBearer Token
This folder is using Bearer Token from collectionCookieScript API

GETList

https://cookie-script.com/api/open/v1/banners

Endpoint: List Banners

Method: GET
URL: https://cookie-script.com/api/open/v1/banners

Description

Returns a list of all banners accessible to the user.

Query Parameters

None.

Response

Example of a successful response:

json
{
  "success": true,
  "message": "",
  "data": [
    {
      "id": "",
      "domain": "",
      "published": true,
      "shared": true,
      "sharedWithMe": true,
      "shareInfo": []
    }
  ]
}
AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionCookieScript API

GETShow

https://cookie-script.com/api/open/v1/banners/show?id=82a26e9448de35155e909dcdbe1b5633

Endpoint: Show Banner

Method: GET
URL: https://cookie-script.com/api/open/v1/banners/show?id=

🔍 Description

Returns detailed information about a specific banner by ID.

Query Parameters

  • id (string, required): Banner ID

Response

200 OK
The response will be in JSON format and will have the following structure:

json
{
  "success": true,
  "message": "",
  "data": {
    "id": "",
    "webSiteUrl": "",
    "settings": [
      {
        "id": "",
        "name": "",
        "value": ""
      }
    ]
  }
}

The response will include a success flag indicating the success status of the request, a message field for any additional information, and a data object containing the detailed information about the specific banner.

AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionCookieScript API
PARAMS
id

82a26e9448de35155e909dcdbe1b5633

DELETEDelete

https://cookie-script.com/api/open/v1/banners/delete?id=9b830d978de36b18974031a9a7d31777

Endpoint: Delete Banner

Method: DELETE
URL: https://cookie-script.com/api/open/v1/banners/delete?id=

Description

Deletes the banner specified by ID.

Query Parameters

  • id (string, required): Banner ID

Response

200 OK
The response will be in JSON format and will have the following structure:

json
{
  "success": true,
  "message": "Item deleted successfully",
  "data": {}
}
AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionCookieScript API
PARAMS
id

9b830d978de36b18974031a9a7d31777

Loading