Subscribers

List the contacts of a list

GET /api/v1/subscribers

Each row has the contact's id, email, status, tags, and one key per field of the list.

Parameters
list_uid string required query
The list's uid.
keyword string query
Only contacts whose fields contain every word.
status string query
Only contacts with this status. One of: subscribed, unsubscribed, unconfirmed, blacklisted, spam-reported.
open string query
yes: only contacts who opened a campaign; no: only contacts who never did. One of: yes, no.
click string query
yes: only contacts who clicked in a campaign; no: only contacts who never did. One of: yes, no.
page integer query
Default: 1
per_page integer query
Contacts per page.
Default: 25
Responses
200 One page of contacts.
400 No list has this list_uid.
401 The token is missing or wrong (Unauthenticated.), or its user may not act on this object (Unauthorized). Without the Accept: application/json header, a missing or wrong token answers with a redirect to the sign-in page instead.
List the contacts of a list
1 2 3
curl 'https://your-domain/api/v1/subscribers?list_uid=6adaabbf98847' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
1 2 3 4 5 6
$client = new Acelle\Client('https://your-domain/api/v1', 'YOUR_API_TOKEN');
$client->subscriber()->all([
    'list_uid' => '6adaabbf98847',
    'per_page' => 25,
    'page' => 1,
]);
Response
[
    {
        "id": 1,
        "email": "anna@example.com",
        "status": "subscribed",
        "tags": [],
        "FIRST_NAME": "Anna",
        "LAST_NAME": "Berg"
    },
    {
        "id": 2,
        "email": "ben@example.com",
        "status": "subscribed",
        "tags": [
            "vip",
            "newsletter"
        ],
        "FIRST_NAME": "Ben",
        "LAST_NAME": "Okafor"
    }
]