Retrieve a mailing

GET

/v4/mailings/:mailingId

Retrieves the details of an existing mailing.

Path parameters

mailingIdstringRequired

The unique identifier for an existing mailing.

Response

createdAtdatetime

The creation date and time of the mailing in ISO 8601 format.

fromobject

The mailing address of the sender.

idstring

The unique identifier for this mailing.

mailedFromIdstring

The documentId of the mailed document.

statusenum

Allowed values: CREATEDPROCESSING_FOR_DELIVERYIN_TRANSITDELIVEREDRETURNED_TO_SENDER

The status of the mailing.

toobject

The mailing address of the recipient.

urlstring

The URL to the mailed document.

userIdstringOptional

The unique identifier for a single end-user of your application.

Errors

GET

1 curl https://sandbox-api.withabound.com/v4/mailings/mailingId_sampleFV9b73IvAD \
2      -H "Authorization: Bearer <apiKey>"

1 {
2   "createdAt": "2024-01-01T00:00:00.000Z",
3   "from": {
4     "address": "256 Byron Street",
5     "country": "US",
6     "address2": "Suite 32",
7     "city": "Palo Alto",
8     "name": "Hooli",
9     "postalCode": "94306",
10     "state": "CA"
11   },
12   "id": "mailingId_sampleFV9b73IvAD",
13   "mailedFromId": "documentId_sampletTtqNfulW8",
14   "status": "CREATED",
15   "to": {
16     "address": "1401 N Shoreline Blvd",
17     "country": "US",
18     "address2": "Suite 1",
19     "city": "Mountain View",
20     "name": "Ada Lovelace",
21     "postalCode": "94043",
22     "state": "CA"
23   },
24   "url": "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-COPY-B.pdf"
25 }

Built with

1	curl https://sandbox-api.withabound.com/v4/mailings/mailingId_sampleFV9b73IvAD \
2	-H "Authorization: Bearer <apiKey>"

1	{
2	"createdAt": "2024-01-01T00:00:00.000Z",
3	"from": {
4	"address": "256 Byron Street",
5	"country": "US",
6	"address2": "Suite 32",
7	"city": "Palo Alto",
8	"name": "Hooli",
9	"postalCode": "94306",
10	"state": "CA"
11	},
12	"id": "mailingId_sampleFV9b73IvAD",
13	"mailedFromId": "documentId_sampletTtqNfulW8",
14	"status": "CREATED",
15	"to": {
16	"address": "1401 N Shoreline Blvd",
17	"country": "US",
18	"address2": "Suite 1",
19	"city": "Mountain View",
20	"name": "Ada Lovelace",
21	"postalCode": "94043",
22	"state": "CA"
23	},
24	"url": "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-1099-COPY-B.pdf"
25	}