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 · enumOptionalPossible values:

Responses

200

Opted-out customers retrieved successfully

application/json

400

Invalid request

post

HTTPcURLJavaScriptPython

POST /v2/ExternalApi/getOptoutCustomers HTTP/1.1
Host: api.gleantap.com
X-API-KEY: text
X-SECRET-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "app_id": "text",
  "limit": 1,
  "offset": 1,
  "type": "email"
}

{
  "members": [
    {
      "id": "text",
      "firstname": "text",
      "lastname": "text",
      "email": "text",
      "phone": "text",
      "email_optout": 1,
      "sms_optout": 1,
      "optout_date": "2025-08-29T15:38:24.568Z"
    }
  ]
}