---
title: "List unsubscribers"
method: GET
path: "/unsubscribers"
tags: ["Unsubscribers"]
---

# List unsubscribers

`GET /unsubscribers`

Returns a paginated list of unsubscribers.

## Query parameters

- `page` integer
- `limit` integer
- `includeTotal` boolean
- `pageAfter` string
- `filter.customer` string — The customer who has opted out.
- `filter.channel` 'whatsapp' — Channel of unsubscriber. - `whatsapp`: Indicates that the customer opts out of receiving WhatsApp messages from your business.
- `filter.regionCode` string — Region code, formatted in [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

## Response `200`

Successfully retrieved a paginated list of objects.

- UnsubscriberPage — Represents a given page of items.
  - `offset` integer, required — The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.
  - `limit` integer, required — A limit on the number of items to be returned, between 1 and 100, defaults to 10.
  - `length` integer, required — The actual number of items in the page.
  - `total` integer — The total number of items. This field is returned only when the request parameter `includeTotal` is set to `true`.
  - `items` object[]

---

[API](https://skmtc.dev/ycloud/apis/ycloud-api.md) · [All operations](https://skmtc.dev/ycloud/apis/ycloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ycloud/ycloud-api/revisions/4e13d3ca9df8/schema)