API - Fields List

View contact custom fields (no data).

Description:

View contact custom fields based on the authenticated user group's lists.

HTTP method:

GET

Supported output formats:

xml, json, serialize

Requires authentication:

true

Parameters:

* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as 

Content-Type: application/x-www-form-urlencoded

. We don't accept any other input formats like JSON.

Variable	Description
account*	YOUR ACCOUNT URL
api_action*	list_field_view
api_key*	Your API key
api_output	xml, json, or serialize (default is XML)
ids*	ID's of the contact custom field you want to view (comma-separated for many; use 'all' to view all)

Example response:

Variable	Description
0	Array
id	3
title	text1
type	text
isrequired	0
perstag	PERS_3
rows	0
cols	0
visible	1
relid	5
dataid	0
element	text
tag	%PERS_3%
1	Array
id	5
title	Field 2x
type	text
isrequired	0
perstag	yoyo
rows	0
cols	0
visible	1
relid	5
dataid	0
element	text
tag	%yoyo%
result_code	Whether or not the response was successful. Examples: 1 = yes, 0 = no
result_message	A custom message that appears explaining what happened. Example: Something is returned
result_output	The result output used. Example: serialize

PHP Example

This is an example of using the contact_sync call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using serialize as the output format. You can change that to XML or JSON if you would like.

<?php

// By default, this sample code is designed to get the result 

$url = 'https://api.t2connect.com/v1/';

// here we define the data we are posting in order to perform an update
$data = array(

   'account'      => 'YOUR_URL',

   // replace this with your API Key
    'api_key'      => 'YOUR_API_KEY',

    // this is the action that adds a contact
   

'api_action' => 'list_field_view',

// define the type of output you wish to get back
// possible values:
// - 'xml' : you have to write your own XML parser
// - 'json' : data is returned in JSON format and can be decoded with
// json_decode() function (included in PHP since 5.2.0)
// - 'serialize' : data is returned in a serialized format and can be decoded with
// a native unserialize() function
'api_output' => 'serialize',

// ID(s) of the contact custom field(s) you wish to fetch - comma-separate for more than one
// You can also pass the personalization tag here, IE: %PERS_7%
'ids' => 'all',
// 'ids' => '1,2,3,4', //an option to only search by ids

);

//open connection
$ch = curl_init($url);
$json_data = json_encode($data);

curl_setopt($ch, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS

$response = (string)curl_exec($ch); // execute curl post and store results in $response

//close connection
curl_close($ch);

$result = unserialize($response);

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';

// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';



?>