---
title: "subscriber.list"
method: GET
path: "/subscriber.list.json"
tags: ["subscriber"]
---

# subscriber.list

`GET /subscriber.list.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/subscriber.list.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Get subscribers list

## Query parameters

- `ids` string
- `start` integer
- `count` integer
- `page_cursor` string
- `subscribed` boolean
- `store_id` string
- `email` string
- `created_from` string
- `created_to` string
- `modified_from` string
- `modified_to` string
- `response_fields` string
- `params` string
- `exclude` string

## Response `200`

successful operation

- ModelResponseSubscriberList
  - `return_code` integer, nullable
  - `return_message` string, nullable
  - `pagination` Pagination
    - `previous` string, nullable
    - `next` string, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `result` ResponseSubscriberListResult
    - `total_count` integer, nullable
    - `subscribers` Subscriber[]
      - `id` string
      - `customer_id` string, nullable
      - `email` string, nullable
      - `subscribed` boolean, nullable
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `stores_ids` string[]
      - `created_time` string, nullable
      - `modified_time` string, nullable
      - `lang_id` string, nullable
      - `gender` string, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

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