The Customer API allows for comprehensive management and querying of customer data within Antavo. With these APIs, you can search for customers using their information, retrieve detailed customer data by customer ID, merge customers, and count the number of active customers in the loyalty program.

By default, these API endpoints focus on active customers, but inactive customers can be included by enabling the option in the Antavo Management UI. Navigate to the Customer settings under the Settings menu.

Endpoints using a customer_id can also be accessed using external IDs by replacing customer_id with the appropriate external_field:external_customer_id, provided the external field is tagged as external_id in the Antavo Management UI.

All Customer API requests must be signed. To comply with GDPR standards, searches for opted-out customers will return empty search results as Antavo does not retain any customer identifiers upon unenrollment.

API Principles

The Customer API follows RESTful principles, utilizing standard HTTP methods to interact with resources. All responses are formatted in JSON, ensuring easy integration into user interfaces.

Security and Compliance

All server-to-server calls must comply with the API security protocol and signing procedure and adhere to the defined API rate limits.