Skip to main content
The Prequel Export API is a REST API. All requests are made over HTTPS to your regional base URL and authenticate with an API key.

​
Base URL

DeploymentBase URL
US (cloud-hosted)https://api.prequel.co
EU (cloud-hosted)https://eu-api.prequel.co
Self-hostedYour configured host

​
Authentication

Authenticate every request with your API key in the X-API-KEY header:
Authenticated request
curl https://api.prequel.co/sources \
  -H "X-API-KEY: $PREQUEL_API_KEY"
Prequel supports two credential types:
  • API keys grant full access to a single environment. A key is scoped to either staging (sk_staging_...) or production (sk_prod_...), and the key you use determines which environment the request reaches. See Environments.
  • Scoped auth tokens are short-lived tokens (one-hour TTL) for client-side use with the React SDK. They grant limited, tenant-scoped access so a token can only read and write data for a single recipient.

​
Versioning

The current API version is 2023-12-01. Pin your integration to it by sending the version header on every request.
Include X-Prequel-Api-Version: 2023-12-01 on all calls. See API versioning for the changes in this version and tips for migrating existing workflows.

​
Request limits

Requests may not exceed a 32 MB payload.

​
Response format

Every response is a JSON object with three top-level fields:
FieldDescription
statusThe outcome of the request.
dataThe requested resource or resources.
messageA human-readable message describing the result.
List endpoints are paginated. Paginated responses add has_next and next_url; follow next_url until has_next returns false. See Pagination for details.

​
Next steps

Create a Postman collection

Generate a ready-to-use Postman collection from the OpenAPI spec.

API versioning

Review the changes in version 2023-12-01 and how to migrate.