List the Lists a Contact is Subscribed to

Overview

This request will return a subset of all the lists a contact is subscribed to. You can include the page, count, order, direction, and filter variables to affect the list you receive.

The Method

Type	Request	Method
REST	GET	https://[Your URL]/api/2.0/contact_subscriptions/:contact_id
XML-RPC	Call	contacts.ContactSubscriptions

Your URL is the address of your install.

Your method must be structured as follows:

ContactSubscriptions(int $contact_id, int $page, int $count, string $order, string $direction, \struct | array $filters) : array

Parameters

Required Parameters

The only required parameter for this request is the $contact_id.

Property	Type	Description	Required
$contact_id	integer	The ID of the contact you are querying.	yes

Optional Parameters

The following parameters are optional:

Property	Type	Description	Required
$page	integer	The page number of the list.	no
$order	string	The name of the field to order the listing with.	no
$count	integer	The number of results to return per page.	no
$direction	string	The direction to order the results in (‘asc’ or ‘desc’).	no
$filters	structarray	The fields to filter on.	no

Responses

Type	Description
array	An array of contacts.

Code Samples

PHP (using REST API)

$url = '(Your URL)/api/2.0/contact_subscriptions/:contact_id';
$method = 'GET';
$cSession = curl_init();
$headers = array();
$auth = base64_encode($username . ':' . $apikey);
$headers[] = 'Authorization: Basic ' . $auth;
curl_setopt($cSession, CURLOPT_URL, $url);
curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);
curl_setopt($cSession, CURLOPT_HEADER, false);
curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));
curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($cSession);
curl_close($cSession);