QUERY CONTACT LISTS

Lists existing contact lists

This operation queries for existing contact lists. Currently, it does not allow filtering and therefore it returns all contact lists.

REQUEST PARAMETERS

Parameter	Data Type	Demo Value	Description
QueryContactLists	object		ContactLists request by query
MaxResults	long	1000	Max number of results to return limited to 1000 (default: 1000)
FirstResult	long	0	Start of next result set (default: 0)

RESPONSE PARAMETERS

Parameter	Data Type	Description
ContactListQueryResult		List of ContactLists returned from query
TotalResults	long	Results count
ContactList		List of Contacts
Id	long
Name	string
Size	integer
Created	dateTime
Status	ContactListStatus	[ACTIVE, VALIDATING, IMPORTING, IMPORT_FAILED, ERRORS, DELETED, PARSE_FAILED, COLUMN_TOO_LARGE]

EXAMPLE

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string QueryContactList()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("contact/list", Method.GET);
            request.AddParameter("MaxResults", "5");
            request.AddParameter("FirstResult", "1");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The XML returned is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<r:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="-1">

   <ContactList id="188611001">

     <Name>NewContactListTest2</Name>

     <Size>1</Size>

     <Created>2014-06-05T18:18:01Z</Created>

     <Status>ACTIVE</Status>

   </ContactList>

</r:ResourceList>