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/v1
  • Versioning 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

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