Sign in

v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
Return Envelopes

List Return Envelopes

Gets a list of return envelopes for the user.

get/print-mail/v1/return_envelopes

Query parameters

skipinteger
limitinteger
string
OR
string

You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource.

For example, let's say you created a series of letters that all had metadata: { campaignID: 'abc' }. You could search for all those letters by passing in { "metadata.campaignID": "abc" } into the search parameter.

Note that this string must be valid JSON.

You can supply any string to help narrow down the list of resources. For example, if you pass "New York" (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on StructuredSearchQuery for more details.

Response

A list object containing return envelopes.

object'list' required
totalCountinteger required
skipinteger required
limitinteger required