Developers

Example Usage of
deal_stage_list

View multiple (a list of) deal stages.

Description: View many (or all) deal stages by including their ID's or various filters. This is useful for searching for deal stages that match certain criteria.
Endpoint: /admin/api.php?api_action=deal_stage_list
HTTP method: GET
Supported output formats: json
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
api_action*deal_stage_list
api_key*Your API key
api_outputjson
filtersSee below code example for all filters you can pass.
fullWhether or not to return ALL data, or an abbreviated portion (set to 1 for ALL data, and 0 for abbreviated).
sortField to sort on (possible values: id, datetime).
sort_directionDirection of sort (possible values: ASC or DESC).
pagePagination: results are limited to 20 per page, so specify what page to view.
Example response:
Variable Description
0Array
idID of the deal stage. Example: 2
titleTitle of the deal stage. Example: 'Follow Up With'
colorHEX value of header color of the deal stage. Example: 'FF0000'
pipelineID of the pipeline the deal stage is in. Example: 3
result_codeWhether or not the response was successful. Examples: 1 = yes, 0 = no
result_messageA custom message that appears explaining what happened. Example: Something is returned
result_outputThe result output used. Example: json

PHP Example

This is an example of using the deal_stage_list 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 from your ActiveCampaign installation and print out the result
$url = 'http://account.api-us1.com';

// optional custom field search: provide field ID, and search query (this searches all custom field values)
/*
$fields = array(
    1 => 'value', // in this case, 1 is the custom field ID, and 'value' is the value you are searching for
);
*/

$params = array(

  // the API Key can be found on the "Your Settings" page under the "API" tab.
  // replace this with your API Key
  'api_key' => 'YOUR_API_KEY',

  'api_action' => 'deal_stage_list',

  // define the type of output you wish to get back
  // possible values:
  // - 'json' :      data is returned in JSON format and can be decoded with
  //                 json_decode() function (included in PHP since 5.2.0)
  'api_output' => 'json',

  // filters (optional): supply filters that will narrow down the results

    // Title: exact match
    //'filters[title]' => 'Follow Up With',

    // Pipeline ID: exact match.
    //'filters[pipeline]' => '12',

    // Hex value of color: exact match
    //'filters[color]' => 'FF0000',


  // whether or not to return ALL data, or an abbreviated portion (set to 0 for abbreviated)
  'full' => 1,

  // optional: change how results are sorted (default is below)
  //'sort' => 'id', // possible values: id, datetime, first_name, last_name
  //'sort_direction' => 'DESC', // ASC or DESC
  //'page' => 2, // pagination - results are limited to 20 per page, so specify what page to view (default is 1)

);

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
    die('JSON not supported. (introduced in PHP 5.2.0)');
}

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);

$response = (string)curl_exec($request); // execute curl fetch and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object

if ( !$response ) {
    die('Nothing was returned. Do you have a connection to Email Marketing server?');
}

// This line takes the response and breaks it into an array using:
// JSON decoder
$result = json_decode($response, true);

// 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>';

// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;?>

Questions? Discuss this API call in our developer forum