Introduction

Read customer data. Customer creation and updates are handled automatically through conversion tracking endpoints.

Overview

  • (GET) Retrieve customers by ID or external ID with pagination support
  • Automatic customer creation/updates through conversion tracking endpoints
  • Read-only access—customer write operations handled via conversion tracking
  • Support for filtering and sorting to efficiently find specific customers

The Customers API provides read-only access to customer data. Customers are automatically created or updated when you track lead or sale conversion events, making it easy to maintain a synchronized customer database without manual intervention.

When you track a lead or sale event using the conversion tracking endpoints (/api/track/lead or /api/track/sale), Hoko automatically creates or updates the customer record based on the customerExternalId. This ensures your customer data stays in sync with your conversion tracking activities.

Use the Customers API to retrieve customer information, verify customer existence, build customer management interfaces, or integrate customer data with other systems. The API supports filtering by customer ID or external ID, making it easy to find specific customers.

Customer Management

Customer write operations (POST, PUT, DELETE) are not available through the Customers API. Customers are automatically created or updated when tracking lead or sale events using the conversionsWrite scope. This design ensures data consistency and simplifies your integration workflow.