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.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Segments/List?accountName=acme&login=ApiUser";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, url))
{
	request.Headers.Add("Password", "YOUR_PASSWORD");

	using (HttpResponseMessage response = await client.SendAsync(request))
	{
		response.EnsureSuccessStatusCode();
		Console.WriteLine(await response.Content.ReadAsStringAsync());
	}
}

# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'https://example.com/API/Rest/Segments/List?accountName=acme&login=ApiUser'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests
url = "https://example.com/API/Rest/Segments/List?accountName=acme&login=ApiUser"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/Segments/List?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&nameSearch=Test"