Filter subscribers

v1
post
/1/newsletters/{domain}/subscribers/filter

Returns a variety of information about one or more Subscribers.

Allows advanced filters (e.g. segmentation).

Path parameters

domain
requiredinteger

Unique identifier of the Domain

Examples:28012

Body Parameters

application/json
filterobject
segmentstring
Examples:example

Response Body

application/json
resultrequiredstring
Possible values:successerrorasynchronous

Result of the HTTP request

Examples:success
dataarrayofSubscriber
totalinteger

Total number of items Added when using query parameter page

Examples:221
pageinteger

Number of the current page Added when using query parameter page

Examples:2
pagesinteger

Total number of pages Added when using query parameter page

Examples:15
items_per_pageinteger

Number of items per page Added when using query parameter page

Examples:15

Example request

                <?php
use GuzzleHttp\Client;

$client = new Client();
$headers = [
	'Authorization' => 'Bearer YOUR-TOKEN-HERE',
	'Content-Type' => 'application/json'
];

$body = '{
    "filter": {
        "groups": [],
        "search": "joseph",
        "status": "bounced"
    },
    "segment": "example"
}';

$request = new Request('POST', 'https://api.infomaniak.com/1/newsletters/{domain}/subscribers/filter', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
            

Example response

application/json
                
                    
{
"result":"success",
"data":[
{
"id":5065,
"email":"maximillian.walter@heaney.com",
"status":"active",
"created_at":1732017990
}
],
"total":221,
"page":2,
"pages":15,
"items_per_page":15
}