GET subscriber.list.json

api2cart.com

Summary: —
Operation ID: SubscriberList
Auth: unknown
Description

Get subscribers list

Parameters (13)

count (integer, query, optional, default: 10)

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

created_from (string, query, optional)

Retrieve entities from their creation date

created_to (string, query, optional)

Retrieve entities to their creation date

email (string, query, optional)

Filter subscribers by email

exclude (string, query, optional)

Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all

modified_from (string, query, optional)

Retrieve entities from their modification date

modified_to (string, query, optional)

Retrieve entities to their modification date

page_cursor (string, query, optional)

Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)

params (string, query, optional, default: force_all)

Set this parameter in order to choose which entity fields you want to retrieve

response_fields (string, query, optional)

Set this parameter in order to choose which entity fields you want to retrieve

start (integer, query, optional, default: 0)

This parameter sets the number from which you want to get entities

store_id (string, query, optional)

Store Id

subscribed (boolean, query, optional)

Filter by subscription status

No probe data for this endpoint yet.