latestOpenAPI 3.0.12026-08-101936151.3 KB
61701b027c74
Postbox Confirmations
Index confirmations associated with a Postbox item
Returns an array containing all confirmations associated with the Postbox item specified in the request URL.<br> Note that you can filter the results by created_at (min or max) and document_type—see the descriptions below.
get/v1/postbox/items/{item_id}/confirmations
Path parameters
item_idstring required
ID of the item whose confirmations should be returned.
Query parameters
filter[created_at][min]string date-time
Filters the response by Postbox items created from a certain date (i.e., the minimum date in the past when the document was created).
filter[created_at][max]string date-time
Filters the response by Postbox items created up until a certain date (i.e., the maximum date in the past when the document was created).
page[number]integer
The number of pages of results to return.
page[size]integer
The amount of entries to return on a single page.
Response
The confirmations were fetched successfully.