List all mailings
Returns a list of mailings. Up to 100 mailings are returned per request.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
page
The specific page of results you’re requesting. Responses are limited to a maximum of 100 records.
status
Filters the list of mailings based on the status
field.
Allowed values:CREATED PROCESSING_FOR_DELIVERY IN_TRANSIT DELIVERED RETURNED_TO_SENDER
userId
The unique identifier for a single end-user of your application.
Response
OK
createdAt
The creation date and time of the mailing in ISO 8601
format.
from
The mailing address of the sender.
id
The unique identifier for this mailing.
mailedFromId
The documentId
of the mailed document.
status
The status of the mailing.
Allowed values:CREATED PROCESSING_FOR_DELIVERY IN_TRANSIT DELIVERED RETURNED_TO_SENDER
to
The mailing address of the recipient.
url
The URL to the mailed document.
userId
The unique identifier for a single end-user of your application.
Errors
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error