📘
Gleantap API
  • Introduction
  • Fetch Data
    • Attribute List
    • Attribute Event List
    • Locations
    • Class Schedule
    • Customers
    • Events for a Customer
    • Opted In Customers
    • Campaigns
    • Opted Out Customers
    • Workrooms
    • Forms
    • Form Submissions
  • Update Data
    • Create or Update Location
    • Create a Class
    • Delete Class
    • Create or Update Contact
    • SMS Opt-in a Contact
    • Add Memberships for Contact
    • Create an Event
    • Delete Contact
    • Merge Contacts
    • Send SMS Notification
    • Send Email Notifications
Powered by GitBook
On this page
  1. Fetch Data

Campaigns

PreviousOpted In CustomersNextOpted Out Customers

Last updated 2 months ago

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
200
Campaigns retrieved successfully
application/json
400
Invalid request
post
POST /v2/ExternalApi/getCampaigns HTTP/1.1
Host: api.gleantap.com
X-API-KEY: text
X-SECRET-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "app_id": "text",
  "campaign_id": "text",
  "updated_since": "2025-06-14",
  "created_since": "2025-06-14",
  "limit": 1,
  "offset": 1
}
{
  "campaigns": [
    {
      "id": "text",
      "campaign_name": "text",
      "status": "text",
      "type": "text",
      "schedule": "text",
      "created_by": "text",
      "created_on": "2025-06-14",
      "subject": "text",
      "sent": 1,
      "opened": 1,
      "clicked": 1
    }
  ]
}