📘
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

Opted In Customers

PreviousEvents for a CustomerNextCampaigns

Last updated 2 months ago

Get opted-in customers

post

Retrieve list of customers who have opted in for communications

Header parameters
X-API-KEYstringRequired

Your API key

X-SECRET-KEYstringRequired

Your Secret key

Body
app_idstringRequired
limitinteger · max: 1000Optional
offsetintegerOptional
Responses
200
Opted-in customers retrieved successfully
application/json
400
Invalid request
post
POST /v2/ExternalApi/getOptinCustomers HTTP/1.1
Host: api.gleantap.com
X-API-KEY: text
X-SECRET-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "app_id": "text",
  "limit": 1,
  "offset": 1
}
{
  "members": [
    {
      "id": "text",
      "firstname": "text",
      "lastname": "text",
      "email": "text",
      "phone": "text",
      "add_date": "2025-05-21"
    }
  ]
}