Import Results | Knowledge Base

Overview

You can use this request to get the results of an import once it is complete.

The Method

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

Your URL is the address of your install.

Your method must be structured as follows:

ImportResults(string $batch_id) : array

Parameters

Required Parameters

The following parameter is required for this request to work:

Property	Type	Description	Default	Required
batch_id	string	The identifier hash of the import batch you want to get results for.	empty	yes

Responses

Type	Description
array	The newly created contacts with their system IDs.

Code Samples

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