Get List of Receipts

Use this API to retrieve a list of all receipts. Depending on the query or header parameter values passed in the request, the response will return specific details about receipts, including relevant information about collection point interactions, purposes, and the associated purpose preferences and attributes.

🗒

Things to Know

• The timespan between the fromDate and toDate values must be 24 hours or less.
• By default, this API retrieves receipts created within the last 90 days. To retrieve receipts stored for more than 90 days, the includeArchived parameter must be used.
• When retrieving historic receipts, set includeArchived=true and provide either the receiptId in the request parameters or the identifier in the request headers. Optional parameters such as includeDataElements, includeConsentStrings, sort, page, and nextMarker can also be used.
• If includeArchived=true is set and additional parameters such as fromDate or toDate` are included, this API will instead search only receipts stored within the last 90 days.
• If the number of records exceeds a single page:
  • The response returns a requestContinuation value, which must be included in the next request body to continue pagination.
  • When retrieving archived receipts, nextMarker must also be included in subsequent request bodies to paginate through results.
• Purpose descriptions in the API response are returned inside <p> and </p> HTML tags. These tags can be sanitized based on your formatting needs.