API Documentation

API DOCUMENTATION

Last Update: July 2025



Premiere Access Enterprise-Level API Calls API Calls Overview Clients (Businesses) Account - Update Account - Info Dashboard - Info Custom Fields Customer Field - Create Customer Fields - List Customer Field - Update Customer Field - Delete Transaction Field - Create Transaction Fields - List Transaction Field - Update Transaction Field - Delete Reward Custom Field - Create Reward Custom Fields - List Reward Custom Field - Update Reward Custom Field - Delete Users (Business Employees) User - New User - Update Users - List User - Info User - Delete Users - Add to Campaign Users - Rem. from Campaign Loyalty Programs Campaign - New Campaign Campaign - New Reward Campaign - New Promo Campaign - New BuyX Item Campaign - New Depreciation Campaign - New Fee Campaign - Update Campaign Campaign - Update Reward Campaign - Update Promo Campaign - Update BuyX Item Campaign - Update Depreciation Campaign - Update Fee Campaign - List Campaigns Campaign - List Deactivated Campaign - List Rewards Campaign - List Promotions Campaign - List Depreciations Campaign - List Fees Campaign - List BuyX Items Campaign - Delete Campaign Campaign - Delete Reward Campaign - Delete Promo Campaign - Delete BuyX Item Campaign - Delete Depreciation Campaign - Delete Fee Campaign - Deactivate Campaign - Reactivate Customers Customer - New/Register Customer - Update Customer - Generate Card # Customer - Batch Customer - Search Customer - Find Customer - Information Customer - Exists Customer - Balance & History Customer - Delete Customer - Validate Card Replace Transactions Transaction - Record Transaction - Redeem Transaction - Batch Transaction - Delete Misc. Calls: Token - Get Token - Validate Audit Reports All Transactions All Redeemed Transactions Campaign Totals Customer Balances Marketing Reports All Customers New Customers Frequent Customers Missing Customers Birthdays Custom Date Range Customer Search Reference Currency Codes Country Codes Timezones Available Languages User Permission Levels Replacement Codes Premium APIs Email Templates Email Template - New Email Template - Update Email Template - Information Email Templates - List Email Template - Delete SMS Templates SMS List Service Providers SMS Add Credentials SMS Update Credentials SMS Template - New SMS Template - Update SMS Template - Information SMS Templates - List SMS Template - Delete Memberships Membership Program - New Membership Program - Update Membership Program - Info Membership Programs - List Membership Program - Delete Membership Level - New Membership Level - Update Membership Level - Info Membership Levels - List Membership Level - Delete Boost Promos Fixed Boost - New Fixed Boost - Update Temporary Boost - New Temporary Boost - Update Recurring Boost - New Recurring Boost - Update Boost - Info Boost - List Boost - Delete

Pre-Existing Report: Customer Balances

Generate a report with all the customer balances for the given campaign.

Headers

		Key		Value		Note
		api_access_key		user_api_key		Optional

The data to be submitted to the API is composed of the following fields:

field	Example	Note
user_id	john1970	Required
user_password	1959caadac9b13dcb3	Required if not included in the headers
account_id	greatwidgets	Required
type	reports	Required
report	customers_balances	Required
coalition_balance	coalition_points or coalition_storedvalue	Optional, see notes.
campaign_id	123456789012	Required
offset	100	Optional
limit	50	Optional

Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Notes:

Headers: the user_api_key value can be included in either the header section or the body of the request. If the key is provided in both locations, the API will process and validate only the value provided in the headers.
NEW Note: To get the Balances Report for the Points Coalition use field: coalition_balance and value: coalition_points. This will provide the customer's points balances accross the coalition. Campaigns that are marked as "opt-out" are not included.
NEW Note: To get the Balances Report for the Gift Card Coalition use field: coalition_balance and value: coalition_storedvalue. This will provide the customer's gift card balances accross the coalition. Campaigns that are marked as "opt-out" are not included.
Only ONE selected_campaign can be run at a time.
The offset and limit are optional and can be used to generate paginated lists, or to limit the reporting range into more manageable chunks / lists.

Example PHP Request:

If you are using PHP, the $data array would look like this:

$data['user_id'] = 'john1970';
$data['user_password'] = '1959caadac9b13dcb3';
$data['account_id'] = 'greatwidgets';
$data['type'] = 'reports';
$data['report'] = 'customers_balances';
$data['campaign_id'] = '123456789012';
$data['offset'] = '100';
$data['limit'] = '50';

Success XML Response (New / Updated User):

<response status="success">
<customer>
<card_number>12345678</card_number>
<code>173648028775637382</code>
<first_name>Jane</first_name>
<last_name>Doe</last_name>
<email>jdoe@email.com</email>
<phone>555-5555</phone>
<address1>123 Main St.</address1>
<address2>Apt 3G</address2>
<city>Anytown</city>
<state>ND</state>
<zip>12345</zip>
<country>NZ</country>
<custom1>She likes cheese!</custom1>
<custom_date>1970-07-14</custom_date>
<customer_username>jdoe123</customer_username>
<record_timestamp>2011-05-07 14:38:59</record_timestamp>
<earned>6021</earned>
<redeemed>-6001</redeemed>
<balance>20</balance>
<balance_equivalent>0.02</balance_equivalent>
<earned_equivalent>6.02</earned_equivalent>
<redeemed_equivalent>-6</redeemed_equivalent>
</customer>
...
</response>

Error XML Response:

<response status="error">
<error>Error message</error>
</response>