Qodex.ai

List all letters

GET {{baseUrl}}/letters

Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters 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 ≤.
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": "2022-01-01", "lt": "2022-01-31T12:34:56Z"} where gt is ›, lt is ‹, gte is ≥, and lte is ≤.
mail_typestring(optional) A string designating the mail postage type. Options are usps_first_class or usps_standard. Defaults to usps_first_class. usps_standard is a cheaper option which is less predictable and takes longer to deliver. usps_standard cannot be used with certified letters, registered letters, or any letters sent outside of the United States.
colorboolean(optional) A boolean that represents which letters to return. Set to true to return only color letters or false to return only black & white letters.
sort_bystring(optional) Sorts letters 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":"ltr_5ba44b462c79f07c","description":"Demo Letter","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"},"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"},"color":true,"double_sided":false,"address_placement":"top_first_page","return_envelope":false,"perforated_page":null,"extra_service":null,"custom_envelope":null,"mail_type":"usps_first_class","url":"https://lob-assets.com/letters/ltr_5ba44b462c79f07c.pdf?version=v1\u0026expires=1568239830\u0026signature=Ob-DUPLJLM4scWQeCDNadPJ4j33MZw16pykOxwv2us-bA7utTYi6oZ8WrEtBYDBBo09XkapR3gdJf0NEr90xAA","merge_variables":null,"carrier":"USPS","tracking_number":null,"tracking_events":[],"thumbnails":[{"small":"https://lob-assets.com/letters/ltr_5ba44b462c79f07c_thumb_small_1.png?version=v1\u0026expires=1568239830\u0026signature=xZUmE8rq8wSECHPEb9c37cUDZBzGUO3XK5LsIPZhI6dOXgm6zJEn8_7tKuZ3JWBmvNJNXdTl_ufkNu4avjQUDw","medium":"https://lob-assets.com/letters/ltr_5ba44b462c79f07c_thumb_medium_1.png?version=v1\u0026expires=1568239830\u0026signature=H7354Qpcm9S4aXbrMsBe6QJ6lSNi9IWPgMJtLWLi4Kyx9tHF8Mp9YEc_IL9x89Jfw4-yRzKDXA410X4W0PssBQ","large":"https://lob-assets.com/letters/ltr_5ba44b462c79f07c_thumb_large_1.png?version=v1\u0026expires=1568239830\u0026signature=54LUIDKZyItA9pnC87d1pJVAuw8bhKLCsMpNWkB3LgdVWxPxxb_c1IyIWAbSR-dyOYEOlDBCc40J4Kns-O_mAg"}],"expected_delivery_date":"2019-08-16","date_created":"2019-08-08T17:09:14.514Z","date_modified":"2019-08-08T17:09:16.850Z","send_date":"2019-08-08T17:09:14.514Z","object":"letter"},{"id":"ltr_da8267c6a6545cd6","description":"Demo Letter","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"},"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"},"color":true,"double_sided":false,"address_placement":"top_first_page","return_envelope":false,"perforated_page":null,"extra_service":null,"custom_envelope":null,"mail_type":"usps_first_class","url":"https://lob-assets.com/letters/ltr_da8267c6a6545cd6.pdf?version=v1\u0026expires=1568239830\u0026signature=HH-5RnbD4x0eJcnEC9HhqKSvQGsbkjovzvqSKgBijUHKIXwEKQJ4CbYhKs_U2q2A1k20Xefcaw7bfdPKozuqCQ","merge_variables":null,"carrier":"USPS","tracking_number":null,"tracking_events":[],"thumbnails":[{"small":"https://lob-assets.com/letters/ltr_da8267c6a6545cd6_thumb_small_1.png?version=v1\u0026expires=1568239830\u0026signature=C1Rs83187HpWGhsg_pJIOhDIKlDtC_IgBBxHiocCEzJ8CncJwqrq5yHke-p97Dv7o81G_pfhFmirai589O6DCw","medium":"https://lob-assets.com/letters/ltr_da8267c6a6545cd6_thumb_medium_1.png?version=v1\u0026expires=1568239830\u0026signature=gz63l0yi3sK_sXjYfIVdLSvkknJFr_O5TWRulo_iKIgS-PosIl6J0tDR6bx_Tv5Ab_w7DABg3qdKZ846MZ7TCw","large":"https://lob-assets.com/letters/ltr_da8267c6a6545cd6_thumb_large_1.png?version=v1\u0026expires=1568239830\u0026signature=4Y1OIymaWkSO3aBIHCeshFAVnF-pDcF2FFqkx_jovaUFuk4FT1SI24L7_POwTRXQHlETMGlzkP_CGgqselRUAA"}],"expected_delivery_date":"2019-08-16","date_created":"2019-08-08T17:08:12.224Z","date_modified":"2019-08-08T17:08:13.990Z","send_date":"2019-08-08T17:08:12.224Z","object":"letter"}],"object":"list","next_url":"https://api.lob.com/v1/letters?limit=2\u0026after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wOFQxNzowODoxMi4yMjRaIiwiaWRPZmZzZXQiOiJsdHJfZGE4MjY3YzZhNjU0NWNkNiJ9","previous_url":null,"count":2}