REST Email Marketing API Documentation

Segments — list

Return information about the current segments.

HTTP VERB

Get

URL

/API/Rest/Segments/List

ARGUMENTS

nameSearch (Optional) The name or part of the name to search for
createDateStart (Optional) The starting date for searches based on when the segment was created.
createDateEnd (Optional) The ending date for searches based on when the segment was created.

Required permission

ViewSegment

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

Date created The date the segment was created.
SegmentId The internal ID for this segment
Name The name provided for the segment
Description Any description provided for the segment
Creator The administrator who created the segment

{"downloadGuid":"57e5797c-246c-4867-b43c-ebc87f02bb4d","totalRows":3,"userData": [["4/14/2011 8:01 AM","25","CRM contacts","EU DC:All CRM contacts","JoeExample"], ["10/1/2014 2:18 PM","136","xmasSpecial","","JoeExample"], ["12/16/2014 10:04 AM","146","2014HappyHolidays","","Sam.Smith"]]}

EXAMPLE

Return information about a segment.

string url = "http://example.com/api/rest/Segments/List/?accountName=acme&login=ApiUser";
							
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "34teh6i6j565ydw4h");
	using (System.Net.WebResponse response = request.GetResponse())
		using (Stream responseStream = response.GetResponseStream())
			using (StreamReader reader = new StreamReader(responseStream, Encoding.UTF8))
				System.Console.WriteLine(reader.ReadToEnd());
}
catch (System.Net.WebException ex)
{
	System.Diagnostics.Debug.Fail(ex.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://example.com/api/rest/Segments/List?accountName=acme &login=ApiUser'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response
						
import requests
url = "http://www.example.com/api/rest/Segments/List?accountName=acme&login=ApiUser";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
							

http://example.com/api/rest/Segments/List?accountName=acme &login=ApiUser &password=sdff34fg34s &nameSearch=Test"

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.