List all mail items

get

https://api.usestable.com/v1/mail-items

Returns a list of mail items associated with your account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Returns mail items whose envelope or scanned contents match this text. Results are ordered by relevance instead of date. Up to 200 characters.

array of strings

Returns only the mail items with these IDs. Repeat the parameter to pass more than one.

locationId

array of strings

Returns mail items at these locations. Repeat the parameter to pass more than one.

locationId

createdAt_gt

string

Returns mail items created after this date (ISO 8601).

createdAt_gte

string

Returns mail items created on or after this date (ISO 8601).

createdAt_lt

string

Returns mail items created before this date (ISO 8601).

createdAt_lte

string

Returns mail items created on or before this date (ISO 8601).

scan.status

string

Returns mail items by scan status. processing: a scan was requested and hasn't been uploaded yet. completed: the scan was uploaded. none: no scan was requested.

scan.createdAt

string

scan.createdAt_gt

string

Returns mail items whose scan was requested after this date (ISO 8601).

scan.createdAt_gte

string

Returns mail items whose scan was requested on or after this date (ISO 8601).

scan.createdAt_lt

string

Returns mail items whose scan was requested before this date (ISO 8601).

scan.createdAt_lte

string

Returns mail items whose scan was requested on or before this date (ISO 8601).

archived

boolean

Returns archived mail items when true and unarchived mail items when false.

isReturnedToSender

boolean

Returns mail items that appear to be returned to sender when true, and mail items that don't when false.

check.status

array of strings

Returns mail items by check status. none: no checks were found in the mail item. notRequested: checks were found but no deposit was requested. processing, completed, and failed follow the deposit lifecycle. Repeat the parameter to match any of several statuses.

check.status

forward.status

string

Returns mail items by forward status. processing: a forward was requested. completed: a shipping label has been created. The mail may not have shipped yet. none: no forward was requested.

shred.status

string

Returns mail items by shred status. processing: a shred was requested. completed: the mail item was shredded. none: no shred was requested.

tagId

array of strings

Returns mail items with any of these tags. Repeat the parameter to pass more than one.

tagId

tagName

array of strings

Returns mail items with any of these tag names. Repeat the parameter to pass more than one.

tagName

clearAt_gt

string

Returns mail items whose storage deadline is after this date (ISO 8601).

clearAt_gte

string

Returns mail items whose storage deadline is on or after this date (ISO 8601).

clearAt_lt

string

Returns mail items whose storage deadline is before this date (ISO 8601).

clearAt_lte

string

Returns mail items whose storage deadline is on or before this date (ISO 8601).

first

integer

Returns the first n results after the after cursor. Up to 500, defaults to 100.

after

string

Returns results after this cursor. Use endCursor from the previous page.

last

integer

Returns the last n results before the before cursor. Up to 500, defaults to 100.

before

string

Returns results before this cursor. Use startCursor from the previous page.

Responses

200Success

400Bad Request

403Forbidden

404Not Found

500Internal Server Error