REST Email Marketing API Documentation

Workflows — List

List the workflows

HTTP VERB

Get

URL

/API/Rest/Workflows/List

ARGUMENTS

(none)


Required permission

ViewWorkflow

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

An array of structures with the following fields:

name The name of the workflow
description A description of the workflow
status The status of the workflow. Running, Paused, Editing, or Testing

[{"name":"Need Gift Card","description":"Process gift cards","status":"Editing"}]

EXAMPLE

List the workflows.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Workflows/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/Workflows/List?accountName=acme&login=ApiUser'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response
							
import requests
url = "https://example.com/API/Rest/Workflows/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/Workflows/List?accountName=acme&login=ApiUser&password=YOUR_PASSWORD