Qodex.ai

List all postcards

GET {{baseUrl}}/postcards

Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.

Request Params

KeyDatatypeRequiredDescription
limitnumber(optional) An integer that designates how many results to return. Defaults to 10 and must be no more than 100.
afterstring(optional) A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the previous_url field in the return response.
beforestring(optional) A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the next_url field in the return response.
include[]string(optional) Request that the response include the total count by specifying include[]=total_count
metadatastring(optional) Filter by metadata key-value pair, e.g. metadata[customer_id]=987654
date_createdstring(optional) Filter by ISO-8601 date or datetime, e.g. { gt: '2012-01-01', lt: '2012-01-31T12:34:56Z' } where gt is ›, lt is ‹, gte is ≥, and lte is ≤.
sizestring(optional) The postcard sizes to be returned. Must be a non-empty string array of valid sizes. Acceptable values are 4x6, 6x9, and 6x11.
scheduledboolean(optional) Set scheduled to true to only return orders (past or future) where send_date is greater than date_created. Set scheduled to false to only return orders where send_date is equal to date_created.
send_datestring(optional) Filter by ISO-8601 date or datetime, e.g. { gt: '2012-01-01', lt: '2012-01-31T12:34:56Z' } where gt is ›, lt is ‹, gte is ≥, and lte is ≤.
mail_typestring(optional)
sort_bystring(optional) Sorts postcards in a desired order. sort_by accepts an object with the key being either date_created or send_date and the value being either asc or desc.

RESPONSES

status: OK

{"data":[{"id":"psc_208e45e48d271294","description":null,"metadata":{},"to":{"id":"adr_210a8d4b0b76d77b","description":null,"name":"LEORE AVIDAR","company":null,"phone":null,"email":null,"address_line1":"185 BERRY ST STE 6100","address_line2":null,"address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2018-12-08T03:01:07.651Z","date_modified":"2018-12-08T03:01:07.651Z","object":"address"},"url":"https://lob-assets.com/postcards/psc_208e45e48d271294.pdf?version=v1\u0026expires=1619218302\u0026signature=NfHHLBSr5tOHA_Z4kij4dKqZG8f3vMDtwvuFVeeF9pV_lylcjLsVVODhNCE5hR6-2slUr6t9WMNsi429Pj7_DA","carrier":"USPS","front_template_id":null,"back_template_id":null,"front_template_version_id":null,"back_template_version_id":null,"date_created":"2021-03-24T22:51:42.838Z","date_modified":"2021-03-24T22:51:42.838Z","send_date":"2021-03-24T22:51:42.838Z","object":"postcard"},{"id":"psc_0e03d1ad7d31f151","description":null,"metadata":{},"to":{"id":"adr_c7cb63d68f8d6","description":null,"name":"JANE DOE","address_line1":"370 WATER ST","address_city":"SUMMERSIDE","address_state":"PE","address_zip":"C1N 1C4","address_country":"CANADA","metadata":{},"date_created":"2018-12-08T03:01:07.651Z","date_modified":"2018-12-08T03:01:07.651Z","object":"address"},"from":{"id":"adr_210a8d4b0b76d77b","description":null,"name":"LEORE AVIDAR","company":null,"phone":null,"email":null,"address_line1":"185 BERRY ST STE 6100","address_line2":null,"address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2018-12-08T03:01:07.651Z","date_modified":"2018-12-08T03:01:07.651Z","object":"address"},"url":"https://lob-assets.com/postcards/psc_208e45e48d271294.pdf?version=v1\u0026expires=1619218302\u0026signature=NfHHLBSr5tOHA_Z4kij4dKqZG8f3vMDtwvuFVeeF9pV_lylcjLsVVODhNCE5hR6-2slUr6t9WMNsi429Pj7_DA","carrier":"USPS","front_template_id":null,"back_template_id":null,"front_template_version_id":null,"back_template_version_id":null,"date_created":"2021-03-24T22:51:42.838Z","date_modified":"2021-03-24T22:51:42.838Z","send_date":"2021-03-24T22:51:42.838Z","object":"postcard"}],"object":"list","next_url":null,"count":2}