Get all subscriptions from multiple profiles

Description

Retrieves all subscription entries from several customer profiles.

Request URL

Method: POST

https://example.com/api/v1.1/subscriptions/list_all

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format. By default – json.
resource_id	int	1	Yes	Resource ID
db_id	int	1	No	Database ID
channel	string	"email"	No	Channel type
status	string	"subscribed"	No	Subscription status
from_id	string	"abcdefghijklmnqrstuvwxyz"	No	First subscription in the list ID
limit	int	1	No	Response data limit

Request example

{
    "db_id": 1,
    "limit": 1,
    "resource_id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
    "data": [
        {
            "_xxh": "12345",
            "channel": "email",
            "db_id": 1,
            "email": "john@example.com",
            "hash_id": "12345",
            "priority": 0,
            "profile_id": "abcdefghijklmnqrstuvwxyz",
            "resource_id": 1,
            "status": "subscribed",
            "custom_fields": {
                "_browser_name": "Firefox",
                "_device_type": "web",
                "custom_field_1": "test value"
            },
            "cats": [
                "category_1",
                "category_2"
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": "3hDmNCv1E3pT62kP8EqdDZN77jmF9RW82p1rFvpui5wxUMdq2EYQJkg",
    "total_count": 1
}

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
next_from_id	string	The index must be passed in the next request to receive another piece of data, until the result output contains 0 history lines
resource_id	int	Subscription resource ID
channel	string	channel type
custom_fields	object	System and custom subscription fields. You can get information about subscription fields in a resource using the /v1.1/resources/fields_get method
cats	array	The resource categories to which the profile is subscribed.

Additionally for the Email channel:

Parameter	Type	Description
email	string	Email address

Additionally for the Push channel:

Parameter	Type	Description
provider	string	Provider type
subscription_id	string	Subscription ID

Additionally for the SMS channel:

Parameters	Type	Description
phone	string	Phone number

Additionally for the Telegram channel:

Parameter	Type	Description
cc_data	object	Chat ID between Telegram bot and user

Additionally for the WhatsApp channel:

Parameter	Type	Description
cc_data	object	WhatsApp user's phone number