---
title: "List subscribers"
method: GET
path: "/api/v1/subscribers"
tags: ["Subscribers"]
---

# List subscribers

`GET /api/v1/subscribers`

## Request

- Base URL: `https://mailcheer.com`
- URL: `https://mailcheer.com/api/v1/subscribers`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Permission required: `subscribers:read`.

`updated_since` returns only the records created or changed since that date.

## Query parameters

- `limit` integer
- `cursor` string
- `status` 'pending' | 'subscribed' | 'unsubscribed' | 'bounced' | 'complained'
- `q` string
- `updated_since` string, date-time

## Response `200`

The requested page.

- object: The envelope of every list. To walk through it: as long as `has_more` is `true`, call the same address again with `?cursor=<next_cursor>`. The order is stable; a page returns at most `limit` items (50 by default, 100 at most).
  - `object` 'list'
  - `data` object[]
    - `id` string
    - `object` 'subscriber'
    - `email` string
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `status` 'pending' | 'subscribed' | 'unsubscribed' | 'bounced' | 'complained'
    - `source` string, nullable
    - `tags` string[]
    - `fields` object
    - `confirmed_at` string, date-time, nullable
    - `unsubscribed_at` string, date-time, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time: The last change to the record: status, name, fields, tags. Keep the largest value you receive and pass it as `updated_since` next time, minus one minute.
  - `has_more` boolean: One more page after this one.
  - `next_cursor` string, nullable: To pass back as `?cursor=` for the next page. `null` on the last page.

## Other responses

- `401`: Key missing, unknown or revoked.
- `403`: The key does not have the requested permission, or the workspace cannot send: `sending_blocked` (suspended, blocked or banned — nothing goes out, through any channel), `commitment_required` (the anti-spam commitment is not accepted), `reputation_blocked` (too many bounces or complaints).

---

[API](https://skmtc.dev/mailcheer/apis/mailcheer-api.md) · [All operations](https://skmtc.dev/mailcheer/apis/mailcheer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailcheer/apis/mailcheer-api/revisions/ba64b7ef2170?raw)