Welcome to the Froogal API Reference, a gateway to Froogal's Customer Loyalty & Engagement platform. Our API empowers developers to seamlessly integrate Froogal's powerful features into their applications, enabling brands to drive exponential growth.
Designed with simplicity and flexibility in mind, our API offers a wide range of functionalities, including loyalty management, transaction reports, and customer journey automation. With our dedicated support team standing by to assist you every step of the way, you can trust that you'll have the resources you need to build and deploy with confidence.
The Froogal API is organized around REST. JSON is returned by all API responses, including errors. Ensure that you authenticate to make requests to the API.
Paginated APIs
APIs that have the 'Paginated' tag contain certain optional and default parameters regarding access. These APIs usually pertain to data models and have a lot of data and therefore need to be chunked for optimization.
| Parameter | Functionality | Default |
|---|---|---|
| page | The index of the page that you are requesting. | 1 |
| perPage | The number of entries that you are chunking each page by. The maximum number of entries perPage that Froogal APIs support is 1000. | 10 |
Time filters for APIs
Many APIs will have two parameters to define a time period for the data being pulled, startTime and endTime. These APIs expect the two timestamps to be formatted in ISO 8601 format, for example: 2025-06-21T00:37:56-06:00, which translates to 21st June 2025, 37 minutes and 56 seconds past midnight, in the -06:00 (CST) Timezone.
API Rate Limits
To ensure a smooth and stable experience for all users, Froogal enforces rate limits on API usage. Each client is allowed a maximum of 5 API calls per second.
If your application exceeds this limit, subsequent requests may be temporarily throttled or blocked. We recommend implementing appropriate retry logic and exponential backoff in your client to gracefully handle rate limit responses. This helps maintain optimal performance while protecting the integrity of the platform for all users.