> For the complete documentation index, see [llms.txt](https://developers.gleantap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.gleantap.com/fetch-data/opted-out-customers.md).

# Opted Out Customers

## Get opted-out customers

> Retrieve list of customers who have opted out of communications

```json
{"openapi":"3.0.0","info":{"title":"Gleantap External API","version":"1.0.0"},"tags":[{"name":"Contacts","description":"Contacts"}],"servers":[{"url":"https://api.gleantap.com","description":"Production server"}],"paths":{"/v2/ExternalApi/getOptoutCustomers":{"post":{"tags":["Contacts"],"summary":"Get opted-out customers","description":"Retrieve list of customers who have opted out of communications","operationId":"e5da7c72f263feed6037626e7c825579","parameters":[{"name":"X-API-KEY","in":"header","description":"Your API key","required":true,"schema":{"type":"string"}},{"name":"X-SECRET-KEY","in":"header","description":"Your Secret key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["app_id"],"properties":{"app_id":{"type":"string"},"limit":{"type":"integer","maximum":1000},"offset":{"type":"integer"},"type":{"type":"string","enum":["email","sms"]}},"type":"object"}}}},"responses":{"200":{"description":"Opted-out customers retrieved successfully","content":{"application/json":{"schema":{"properties":{"members":{"type":"array","items":{"properties":{"id":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"email_optout":{"type":"integer"},"sms_optout":{"type":"integer"},"optout_date":{"type":"string","format":"date-time"}},"type":"object"}}},"type":"object"}}}},"400":{"description":"Invalid request"}}}}}}
```