Get a List of Contacts | Knowledge Base

Overview

This request will return a subset of all your contacts. Use the page and count parameters to get the whole list.

The Method

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

Your URL is the address of your install.

Your method must be structured as follows:

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

Parameters

You can include the following parameters to affect the list which the system returns.

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

Responses

Type	Description
array	An array of contacts.

Code Samples

PHP (using REST API)

$url = '(Your URL)/api/2.0/contacts';
$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);