Campaigns

Get campaigns list

post

Retrieve list of campaigns with optional filters

Header parameters

X-API-KEYstringrequired

Your API key

X-SECRET-KEYstringrequired

Your Secret key

Body

app_idstringrequired

campaign_idstringoptional

updated_sincestring · dateoptional

created_sincestring · dateoptional

limitinteger · max: 1000optional

offsetintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gleantap.com/v2/ExternalApi/getCampaigns' \
  --header 'X-API-KEY: text' \
  --header 'X-SECRET-KEY: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "app_id": "text",
    "campaign_id": "text",
    "updated_since": "2025-04-02",
    "created_since": "2025-04-02",
    "limit": 1,
    "offset": 1
  }'

200

400

200

{
  "campaigns": [
    {
      "id": "text",
      "campaign_name": "text",
      "status": "text",
      "type": "text",
      "schedule": "text",
      "created_by": "text",
      "created_on": "2025-04-02",
      "subject": "text",
      "sent": 1,
      "opened": 1,
      "clicked": 1
    }
  ]
}

Campaigns retrieved successfully