Refiner API

The Refiner REST API gives you programmatic access to the data stored in your Refiner environment.

Among other things, you can use our API to:

• Retrieve individual survey responses
• Retrieve contacts together with their survey responses and user traits
• Import user traits and events from your backend system
• Import survey responses from other systems

Updating user traits through the API is particularly useful when you want to attach data that should not be exposed in your frontend application, or when you want to use backend data for user segmentation and survey targeting.

The Refiner API follows REST principles, uses JSON for requests and responses, and authenticates requests using API keys.

API Reference

Our API reference contains detailed information about available endpoints, request parameters, authentication, and response formats.

API Keys

You can create and manage API keys under Environment Settings > API Keys.

Each API key can be given a descriptive name, making it easier to identify where it is being used. You can also see when a key was last used and revoke it at any time by deleting it.

You can create multiple API keys within the same environment.

We recommend creating a separate API key for each integration or application that connects to the Refiner API. This makes it easier to identify how individual keys are being used and allows you to revoke or replace one key without affecting other integrations.

Treat your API keys as sensitive credentials and never expose them in publicly accessible frontend code.

Rate Limits

To ensure reliable API performance, requests are subject to the following rate limits:

The per-user limit applies to requests associated with the same user identifier, regardless of the API key being used.

If you expect to send a large number of requests, we recommend spreading them evenly over time rather than sending them in large bursts.