Prequel exposes a RESTful API to configure sources and destinations, initiate data transfers, monitor activity and more.

Versioning

Prequel uses API versioning to ensure backwards compatibility while introducing new features. The current API version is 2023-12-01. To learn more, see: Versioning Overview.

Authentication

API Keys

API keys are used for server-side request and provide full access to your Prequel environment. API keys are scoped to either your Staging or Production environment. See here for more information on Environments.

Include your API key in request headers with:

X-API-KEY: YOUR_API_KEY

For all non-self-hosted instances, API keys are issued and managed by Prequel. Contact the Prequel team with for additional information on API key provisioning.

Scoped Auth Tokens

Scoped auth tokens are short-lived tokens (TTL of one hour) designed for client-side requests when using the Prequel React SDK. These tokens provide limited, scoped access to specific resources. To learn more, see: Authentication.

Additional Detail

Response Format: As of version 2023-12-01, all API request responses return a body containing three objects: status, data, message
- Paginated endpoints will contain up to additional fields has_next and next_url. For more information on pagination, see: Pagination.
Payload Limit: Prequel enforces a 32MB maximum payload size on all API requests.

What’s Next

What’s Next