ListsContacts Method - GET

Mailjet › REST API Documentation › Lists Methods › ListsContacts Method

Description

Show all your contacts within a list.

Request URL

api.mailjet.com/0.1/listsContacts

Code Sample

<?php
 
# Parameters
$params = array(
    'id' => '123'
);
# Call
$response = $mj->listsContacts($params);
 
# Result
$contacts = $response->result;
$count = $response->total_cnt;
 
?>

Parameters

id (Integer, required)

› Description: Mailjet's List ID

blocked (Boolean, optional)

› Description: 0=blocked, 1=active

last_activity (Timestamp, optional)

› Description: Minimum timestamp of the last activity relative to this contact.

limit (Integer, optional)

› Description: Limit amount of results your want

orderby (String, optional)

› Description: any field sent in return

› Default value: id ASC

start (Integer, optional)

› Description: Start offset

status (String, optional)

› Description: opened, active, unactive or unsub.

unsub (Boolean, optional)

› Description: 0=subscriber, 1=unsubscribed

Return

status (String)

› Description: Status of the response

result (Array)

› Description: List of contacts

Label	Type	Description
created_at	Timestamp	Date of subscription of your contact
email	String	Email of your contact
id	Integer	Mailjet's Contact ID
last_activity	Timestamp	Timestamp of the last activity relative to this contact.
sent	Integer	Amount of emails sent to this contact

total_cnt (Integer)

› Description: Total amount of contacts in this List