API Introduction
Overview
The Pristo API allows external systems to securely integrate with Pristo in order to manage contacts, send events, and synchronize operational and customer-related data.
The API is designed using a RESTful, design-first approach, with predictable resource-oriented URLs, standard HTTP methods, and structured JSON payloads. All endpoints are documented and versioned to ensure backward compatibility and safe evolution over time.
This documentation describes Pristo API V1, which is intended for production integrations.
API Base URL & Versioning
All API requests are made against a versioned base URL:
https://api.pristo.example.com/v1Versioning is handled via the URL path (
/v1)Breaking changes will be introduced only in new major versions
Minor, backward-compatible enhancements may be added within the same version
Authentication
The Pristo API uses API Key authentication.
How Authentication Works
Each request must include a valid API key
The API key identifies the client system and controls access permissions
Requests without a valid API key will be rejected
Authentication Header
Include the API key in every request header:
Security Notes
API keys should be kept secret and never exposed in client-side code
Rotate API keys periodically according to your security policy
Requests over HTTP are not supported — HTTPS is required
Obtaining an API Key
Follow these steps to generate your unique key:
1. Click on your Profile icon in the top right corner.
2. Select Account Settings from the dropdown menu.
3. Navigate to the API Keys tab and click the "+Add" button.
Enter a descriptive name for the key so you can easily identify it later.
Copy the new key immediately. Store it securely, as it will not be displayed again.
Your API key will only be displayed once. You will not be able to view it again after closing the window.
Request & Response Format
Content Type
All requests and responses use JSON:
Date & Time Format
All timestamps use ISO 8601 format in UTC:
Example:
Last updated