Opted Out Customers

Get opted-out customers

post

Retrieve list of customers who have opted out of communications

Header parameters

X-API-KEYstringrequired

Your API key

X-SECRET-KEYstringrequired

Your Secret key

Body

app_idstringrequired

limitinteger · max: 1000optional

offsetintegeroptional

typestring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gleantap.com/v2/ExternalApi/getOptoutCustomers' \
  --header 'X-API-KEY: text' \
  --header 'X-SECRET-KEY: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "app_id": "text",
    "limit": 1,
    "offset": 1,
    "type": "email"
  }'

200

400

200

{
  "members": [
    {
      "id": "text",
      "firstname": "text",
      "lastname": "text",
      "email": "text",
      "phone": "text",
      "email_optout": 1,
      "sms_optout": 1,
      "optout_date": "2025-04-02T15:29:44.885Z"
    }
  ]
}

Opted-out customers retrieved successfully