DocumentationAPI Reference
API Reference

Changes in API Version 2023-12-01

Below you will find key changes from the Prequel Base API version to 2023-12-01 and tips for migrating existing workflows.

Prequel API version 2023-12-01 introduces pagination for list endpoints, vendor-shaped destination, and updated request formats, designed to improve performance and clarity of the Prequel API.

❗️

On October 14th, 2025, version 2023-12-01 will become the default version when no X-PREQUEL-API-VERSION header is set on API requests. On November 11th, 2025, Base API version 2022-01-01 will become fully unavailable.

See key detail about breaking changes and contact Prequel support with any additional questions in planning your API migration.

📘

To use the current API version 2023-12-01, specify the header X-PREQUEL-API-VERSION with value 2023-12-01 on all API requests.

Note: All Prequel React SDK versions >= 1.0 utilize API version 2023-12-01 on backend calls.

Changes in this version

  1. Pagination - All Prequel resource list endpoints now return paginated responses.
  2. Vendor-Shaped Sources and Destinations - Destination endpoints now include vendor-specific object shapes for clarity.
  3. Request Format Changes - Updated field requirements for magic links and recipients.
  4. Export Route Deprecation - Backwards-compatible/export/... routes will be removed in favor of the non-prefixed versions.
  5. Test Connection Responses - Consistent response format on test connection endpoint calls.
  6. Migration Tips - See recommendations for your API migration.

1. Pagination

All Prequel resource list endpoints now return paginated responses instead of complete results. All implementations of GET endpoints to receive complete data will need to be updated. See Affected Endpoints below for a complete list.

What Changed

In the Base version, list endpoints returned all results:

GET /destinations
{
  "status": "success",
  "data": {
    "destinations": [
      // All destination objects
    ]
  }
}

In 2023-12-01, Prequel provides paginated responses:

GET /destinations
Headers: { "X-Prequel-Api-Version": "2023-12-01" }

{
  "data": { "destinations": [...] },  // Only the first 10 destinations are returned by default
  "has_next": true,
  "next_url": "/destinations?cursor=eyJpZCI6IjEyMyJ9"
}

Pagination Parameters

ParameterDescription
page_sizeItems per page returned. Acceptable values range from 1 to a maximum of 100. The default when no value is supplied is 10. Any value provided outside this range will return an Error.
cursorPagination token from next_url.
orderSort order, either asc or desc. The default when no value is supplied is desc

Fetching All Results

To fetch all results, you must either:

Follow pagination links: Use the next_url from each response to fetch subsequent pages. Continue calling the next_url until has_next is false to get all results.

Use a page size guaranteeing all results returned: Otherwise, set page_size=100 or another threshold if there is a guarantee that you will not exceed 100 objects returned.

Affected Endpoints

The following Prequel resource list endpoints are now paginated:

  • /destinations, /recipients, /sources, /transfers, /destinations/:destination_id/transfers, /destinations/:destination_id/activity, /destinations-for-recipient, /reports/transfers, /logs, /magic-links, /webhooks, /models, /products, /recipient-source-credentials

Migration priority: If you use any of these endpoints programmatically, update your code before switching to 2023-12-01.

2. Vendor-Shaped Sources and Destinations

Sources and Destinations now use vendor-specific object structures with enhanced validation. Instead of flat configuration objects, each vendor requires a nested configuration object. You can review the particular shape of destinations in the Prequel API reference found here: Create Destination.

Example change:

// Base version: flat object
{ "vendor": "postgres", "host": "db.com", "port": 5432 }

// 2023-12-01: vendor-shaped object  
{ "vendor": "postgres", "postgres": { "host": "db.com", "port": 5432 } }

Field updates:

  • Athena: username field renamed to workgroup

Request Format Changes

Recipients

Recipients no longer accept the schema field. id_in_provider_system is required for tenant identification.

POST /recipients
{
  "recipient": {
    "name": "Customer Name",
    "id_in_provider_system": "tenant123",
    "products": ["all"]
  }
}

Magic Links

Magic Links now require an existing recipient_id and can no longer be generated by passing an id_in_provider_system. Recipients must be created first, then reference its ID when creating the magic link.

POST /magic-links
{
  "recipient_id": "existing-recipient-uuid",
  "vendor": { ... },
	"name": { ... }
}

The id_in_provider_system and products fields are no longer directly accepted in magic link creation.

Test Connection Responses

Test connection endpoints now return consistent responses with a success boolean field, regardless of the connection result.

// Successful test connection
{
  "status": "success",
  "data": {
    "status": "success",
    "success": true
  }
}

// Failed test connection (still HTTP 200)
{
  "status": "success",
  "data": {
    "status": "error",
    "success": false,
    "error": {
      "error_code": "PRQL-1234",
      "title": "Connection Error",
      "message": "Connection details..."
    }
 }

Export Route Deprecation

Though currently supported in version 2023-12-01 for backward compatibility, Prequel will be deprecating endpoints with the /export/ prefix from endpoint URLs. The behavior of all /export/ and the corresponding non-prefixed endpoint behave identically in version 2023-12-01

What's changing:

  • /export/destinations will no longer be available, only the /destinations endpoints.
  • /export/sources will no longer be available, only the /sources endpoints.
  • As will be the case for all endpoints currently supporting the /export/ prefix

Action required:

  • If you are already using the non-prefixed versions of routes, no action is required.
  • New integrations should use the simplified routes without the /export/ prefix.
  • Existing integrations leveraging the /export/ on version 2023-12-01 can simply drop the /export/ prefix. There is no change in behavior between the prefixed and non-prefixed versions of the endpoints.

Migration Tips

Inventory API Calls - Review API calls against Prequel endpoints in each breaking change category above include all GET endpoints.

Test with a Postman Collection - Configure Prequel's published Open API spec for version 2023-12-01 as a Postman collection to test individual endpoints with these instructions: Creating a Prequel API Postman Collection

Review all GET Use Cases - Pagination is the primary change affecting API scripted workflows. If you have scripts that fetch all transfers, destinations, recipients, or models, they'll only receive partial results until pagination is handled. Prioritize testing accordingly.

Add API Version Header Universally: After testing, add X-Prequel-Api-Version: 2023-12-01 to all Prequel API calls to verify to ensure you are compatible prior to the default version changing on September 16th, 2025.

👍

If you have any questions or concerns with your API migration, contact the Prequel team. We are here to help!