Skip to main content
View Markdown
BundlesAuth requiredretrieveBundle

Retrieve a Bundle

GEThttps://api.blueink.com/api/v2/bundles/{bundleSlug}/

Retrieve a Bundle

GET 
/bundles/:bundleSlug/

Retrieve a Bundle by its slug. Optionally include additional related data such as form field data, audit events, and downloadable files using the include query parameter.

Using the include parameter​

The include parameter allows you to fetch related data in a single API call instead of making separate requests to the /data, /events, and /files endpoints. This can significantly reduce the number of API calls needed and improve performance.

Examples:​

Basic bundle retrieval:

GET /api/v2/bundles/abc123/

Include form data only:

GET /api/v2/bundles/abc123/?include=data

Include events and files:

GET /api/v2/bundles/abc123/?include=events,files

Include all additional data:

GET /api/v2/bundles/abc123/?include=data,events,files

Data Availability​

  • data: Only available for completed bundles, unless early data access is enabled for your account
  • events: Always available for any bundle
  • files: Only available for completed bundles with final documents ready, unless early file access is enabled

When data or files are not available, the corresponding field will be null in the response.

Request​

Responses​

A Bundle object, optionally with additional included data