Skip to main content
You can generate a ready-to-use Postman collection from Prequel’s OpenAPI 3.1 spec, then use it to explore and test every Export API endpoint.

​
Prerequisites

  • Postman v10 or later.
  • The Prequel Export OpenAPI spec URL: https://docs.prequel.co/generated/openapi-generated-2023-12-01.json
1

Open Import

In Postman, click the Import button in the left sidebar.
2

Configure the import

  1. Paste the spec URL: https://docs.prequel.co/generated/openapi-generated-2023-12-01.json
  2. Select Postman Collection as the import format.
  3. Click View Import Settings and disable Enable optional parameters and Include deprecated properties.
  4. Click Import.
Postman generates a collection with one request per API operation.
3

Create an environment

Add a new Postman environment with these variables, then reference them from each request:
VariableValue
apiKeyYour staging (sk_staging_...) or production (sk_prod_...) API key.
baseUrlYour API endpoint: https://api.prequel.co, https://eu-api.prequel.co, or your configured host.
Reference {{apiKey}} from each request’s X-API-KEY header and {{baseUrl}} as the request base URL.

​
Next steps

  • Expand the collection and send a request to confirm your environment works.
  • Enhance the collection with examples, tests, or pre-request scripts.
  • Re-import the spec periodically to pick up API updates.