increase-test
GET/inbound_mail_items

List inbound mail items

Lists inbound mail items delivered to your lockbox addresses. Filter the results by lockbox_recipient_id, lockbox_address_id, or creation time, and use cursor to continue through the results.

8 parameters
cursorstringoptional
Cursor for the page of entries to retrieve; use the previous response's `next_cursor` to continue.
limitintegeroptional
Maximum number of mail items to return. Must be at least 1 and no more than 100. Defaults to 100 when omitted.
Default:100
lockbox_recipient_idstringoptional
Filter mail items sent to the specified lockbox recipient.
lockbox_address_idstringoptional
Filter mail items sent to the specified lockbox address.
created_at.afterstringoptional
Return mail items created after this ISO 8601 date-time.
created_at.beforestringoptional
Return mail items created before this ISO 8601 date-time.
created_at.on_or_afterstringoptional
Return mail items created at or after this ISO 8601 date-time.
created_at.on_or_beforestringoptional
Return mail items created at or before this ISO 8601 date-time.

3 status codes
200Returns a list of inbound mail item objects and a `next_cursor` for retrieving the next page; the cursor is null when there are no more results.
dataarray<InboundMailItem>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request encounters a client error.
5XXReturned when the server encounters an error.

Error handling

The limit query parameter must be at least 1 and cannot exceed 100; it defaults to 100 when omitted. Creation-time filters must use ISO 8601 date-time values.