Developers

Example Usage of
group_view

View a specific User Group.

Description: View just a single User Group details and settings.
Endpoint: /admin/api.php?api_action=group_view
HTTP method: GET
Supported output formats: xml, json, serialize
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*group_view
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
id*ID of the User Group you wish to view
Example response:
Variable Description
limit_mailLimitations for sending mail. Example: 0
limit_mail_typeTimeframe for limited mail sending. Example: month
limit_subscriberLimitations to number of contacts.
limit_listLimitations to number of lists.
limit_campaignLimitations to number of campaigns.
limit_campaign_typeTimeframe for limited campaigns. Example: month
limit_attachmentLimitations to number of attachments. Example: -1
limit_userLimitations to number of users. Example: 0
abuseratio4
forcesenderinfo0
idID of the group. Example: 3
titleName of the group. Example: Admin
descriptDescription of the group. Example: This is a group for admin users (people that can manage content)
unsubscribelinkWhether or not to force unsubscribe links. Example: 0
p_adminWhether or not this group has admin privileges. Example: 1
pg_list_addPermission for adding lists. Example: 1 = yes, 0 = no
pg_list_editPermission for editing lists. Example: 1 = yes, 0 = no
pg_list_deletePermission for deleting lists. Example: 1 = yes, 0 = no
pg_list_headersPermission for managing custom email headers. Example: 1 = yes, 0 = no
pg_list_emailaccountPermission for managing Unsubscribe By Email. Example: 1 = yes, 0 = no
pg_list_bouncePermission for accessing list bounce settings. Example: 1 = yes, 0 = no
pg_message_addPermission for adding messages. Example: 1 = yes, 0 = no
pg_message_editPermission for editing messages. Example: 1 = yes, 0 = no
pg_message_deletePermission for deleting messages. Example: 1 = yes, 0 = no
pg_message_sendPermission for sending messages. Example: 1 = yes, 0 = no
pg_subscriber_addPermission for adding contacts. Example: 1 = yes, 0 = no
pg_subscriber_editPermission for editing contacts. Example: 1 = yes, 0 = no
pg_subscriber_deletePermission for deleting contacts. Example: 1 = yes, 0 = no
pg_subscriber_importPermission for importing contacts. Example: 1 = yes, 0 = no
pg_subscriber_approvePermission for approving contacts. Example: 1 = yes, 0 = no
pg_subscriber_exportPermission for exporting contacts. Example: 1 = yes, 0 = no
pg_subscriber_syncPermission for syncing contacts. Example: 1 = yes, 0 = no
pg_subscriber_filtersPermission for managing contact list segments. Example: 1 = yes, 0 = no
pg_subscriber_fieldsPermission for managing contact custom fields. Example: 1 = yes, 0 = no
pg_user_addPermission for adding users. Example: 1 = yes, 0 = no
pg_user_editPermission for editing users. Example: 1 = yes, 0 = no
pg_user_deletePermission for deleting users. Example: 1 = yes, 0 = no
pg_group_addPermission for adding groups. Example: 1 = yes, 0 = no
pg_group_editPermission for editing groups. Example: 1 = yes, 0 = no
pg_group_deletePermission for deleting groups. Example: 1 = yes, 0 = no
pg_template_addPermission for adding templates. Example: 1 = yes, 0 = no
pg_template_editPermission for editing templates. Example: 1 = yes, 0 = no
pg_template_deletePermission for deleting templates. Example: 1 = yes, 0 = no
pg_personalization_addPermission for adding personalization tags. Example: 1 = yes, 0 = no
pg_personalization_editPermission for editing personalization tags. Example: 1 = yes, 0 = no
pg_personalization_deletePermission for deleting personalization tags. Example: 1 = yes, 0 = no
pg_form_editPermission for editing subscription forms. Example: 1 = yes, 0 = no
pg_reports_campaignPermission for viewing campaign reports. Example: 1 = yes, 0 = no
pg_reports_listPermission for viewing list reports. Example: 1 = yes, 0 = no
pg_reports_userPermission for viewing user reports. Example: 1 = yes, 0 = no
pg_reports_trendPermission for viewing trend reports. Example: 1 = yes, 0 = no
pg_startup_reports0
pg_startup_gettingstarted0
sdate2011-03-02 14:46:40
socialdata0
lists1,2
emails_sent0
usersArray
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: serialize

PHP Example

This is an example of using the group_view 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';


$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',

	// this is the action that fetches a group info based on the ID you provide
	'api_action'   => 'group_view',

	// define the type of output you wish to get back
	// possible values:
	// - 'xml'  :      you have to write your own XML parser
	// - 'json' :      data is returned in JSON format and can be decoded with
	//                 json_decode() function (included in PHP since 5.2.0)
	// - 'serialize' : data is returned in a serialized format and can be decoded with
	//                 a native unserialize() function
	'api_output'   => 'serialize',

	// ID of the group you wish to fetch
	'id'           => 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);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

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