website logo
⌘K
Platform Guides
Retail Quick Start Guide
Mission Control
Alerts Manager
Personas
Audiences
Campaigns
Discounts
App Wallets
Analytics
Alpine IQ Integrations
Brands Platform Settings
Loyalty Financial Reporting
Release Notes
March 2023
January 2023
December 2022
November 2022
October 2022
September 2022
August 2022
July 2022
API
Common use cases
Store locations
Personas
Audiences
Campaigns
Discounts
Terms & Conditions
Alpine IQ Services Agreement
Terms & Conditions (Before 3-20-2023)
Terms & Conditions (October 1st, 2021 through September 30th, 2022)
Acceptable Use Policy
Charge policy
EULA (Apple and Google Play Apps)
Sunset features
Smoke Signals Archive
Docs powered by archbee 
4min

API

Welcome to the Alpine IQ REST API

To get started developing on the AIQ system you will need to obtain an API key and authorize your first request.

  1. Login to the AIQ customer portal
  2. Navigate to "Settings" in the left nav bar
  3. Click on "API" in the tab options on the top of the settings page
  4. Copy your API key via the input field

If you would like a sandbox account, please reach out to our support team for approval. Once you have your API key you will be ready to call our endpoints.

API limits

API limits: 5 – second, 120 – minute, 2000 – hour

Endpoints

It is required to pass your "Unique user ID" to each endpoint. In the screenshot above you will see "Your UID for requests is: 1". Your user ID will be listed here: https://lab.alpineiq.com/api/v1.1/{Endpoint}/{UUID}

Header

It is required to to pass your API key as header "X-APIKEY" for all requests

Please visit our most common use cases here: https://support.alpineiq.com/common-use-cases

Updated 03 Mar 2023
Did this page help you?
Yes
No
UP NEXT
Common use cases
Docs powered by archbee 
TABLE OF CONTENTS
Welcome to the Alpine IQ REST API
API limits
Endpoints
Header