Qodex.ai

List all checks

GET {{baseUrl}}/checks

Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks 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.
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 ≤.
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
mail_typestring(optional) Checks must be sent usps_first_class
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 ≤.
sort_bystring(optional) Sorts checks 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":"chk_0176bf6197100185","description":"Demo Check","metadata":{},"check_number":12559,"memo":"rent","amount":22.5,"url":"https://lob-assets.com/checks/chk_0176bf6197100185.pdf?version=v1\u0026expires=1568239682\u0026signature=aqKV5lmg_ktxzyl-qEwIf8-7DbvcguLO0LrfFcyMrUDDt6hxX_da0MEEpElxKR876VUaZrpHq_i_ayDWrsK3BA","to":{"id":"adr_bae820679f3f536b","name":"HARRY ZHANG","address_line1":"185 BERRY ST STE 6100","address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2018-12-08T03:08:43.446Z","date_modified":"2018-12-08T03:08:43.446Z","object":"address"},"from":{"id":"adr_210a8d4b0b76d77b","name":"LEORE AVIDAR","address_line1":"185 BERRY ST STE 6100","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"},"bank_account":{"id":"bank_8cad8df5354d33f","description":"Test Bank Account","metadata":{},"routing_number":"322271627","account_number":"123456789","account_type":"individual","signatory":"John Doe","bank_name":"J.P. MORGAN CHASE BANK, N.A.","verified":true,"date_created":"2015-11-06T19:24:24.440Z","date_modified":"2015-11-06T19:41:28.312Z","object":"bank_account"},"carrier":"USPS","tracking_events":[],"thumbnails":[{"small":"https://lob-assets.com/checks/chk_0176bf6197100185_thumb_small_1.png?version=v1\u0026expires=1568239682\u0026signature=T8DfMm_mxJJzIPgm8I0lvYY4Z6I8aFjsGsrEAicEqw8Ei_FaOtiGQKGeY16rdugAt8lmS_iX0lveBoG2RgWDDw","medium":"https://lob-assets.com/checks/chk_0176bf6197100185_thumb_medium_1.png?version=v1\u0026expires=1568239682\u0026signature=-iJD7C58xOCD8eQ01StqSlw9WbDymL0Ygze9twfTs9s17zQppr2Zx363_Z4bP3ATHNhF3osjHuAxIasI2Wf6DQ","large":"https://lob-assets.com/checks/chk_0176bf6197100185_thumb_large_1.png?version=v1\u0026expires=1568239682\u0026signature=VJlOkVDPKZThstdd632r3Grm2WhoyPkC-pffpcePTw1i1NkpAObDSRaItKMOQgeWkAcUud3SH0tYcVOadaNiCw"},{"small":"https://lob-assets.com/checks/chk_0176bf6197100185_thumb_small_2.png?version=v1\u0026expires=1568239682\u0026signature=XpCkOjy2zIKXkuc0s-UAYGNwpD_pgt7c9FKTDUCYbyqXupAg1MV1l2tdqevr0L0LT5FJqrGZH9khD5QRMQTkAA","medium":"https://lob-assets.com/checks/chk_0176bf6197100185_thumb_medium_2.png?version=v1\u0026expires=1568239682\u0026signature=sdgnJMzusEfndu7dNmk37eKc0AV7Hmqev6TQAqkCESs5pg7j6dDTsp7v4pnDvhsj8d7SIMcahl1aGiysoom0CA","large":"https://lob-assets.com/checks/chk_0176bf6197100185_thumb_large_2.png?version=v1\u0026expires=1568239682\u0026signature=ybe8ovBh8Gf-AWKGRs4CB4XkU-erPVbY66umXARhTiJG2Dg1QlyCb9WmBXWt0tBCwD5NGMl20mHeAgHwecLxBA"}],"expected_delivery_date":"2019-08-16","mail_type":"usps_first_class","date_created":"2019-08-08T19:34:47.571Z","date_modified":"2019-08-08T19:34:49.612Z","send_date":"2019-08-08T19:34:47.571Z","object":"check"},{"id":"chk_92b9a6714bc0557c","description":"Demo Check","metadata":{},"check_number":12558,"memo":"rent","amount":22.5,"url":"https://lob-assets.com/checks/chk_92b9a6714bc0557c.pdf?version=v1\u0026expires=1568239682\u0026signature=jCct5PvzU58Iz2pSo58nf6rgsMRcJfMbUWThmm6lztFl5Vn2Y204b9h7gvw0vJvkDK2ThfaYqaUbWc0KzTpvAg","to":{"id":"adr_bae820679f3f536b","name":"HARRY ZHANG","address_line1":"185 BERRY ST STE 6100","address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2018-12-08T03:08:43.446Z","date_modified":"2018-12-08T03:08:43.446Z","object":"address"},"from":{"id":"adr_210a8d4b0b76d77b","name":"LEORE AVIDAR","address_line1":"185 BERRY ST STE 6100","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"},"bank_account":{"id":"bank_8cad8df5354d33f","description":"Test Bank Account","metadata":{},"routing_number":"322271627","account_number":"123456789","account_type":"individual","signatory":"John Doe","bank_name":"J.P. MORGAN CHASE BANK, N.A.","verified":true,"date_created":"2015-11-06T19:24:24.440Z","date_modified":"2015-11-06T19:41:28.312Z","object":"bank_account"},"carrier":"USPS","tracking_events":[],"thumbnails":[{"small":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_small_1.png?version=v1\u0026expires=1568239682\u0026signature=ublquO_xAdvAkAwGJuOjgZQwcz7c3Ao4NHWHeDVTBEBjcrQr8LavxWEwUc1KU105Zex3SajRQLd6hqJOrDl0Bw","medium":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_medium_1.png?version=v1\u0026expires=1568239682\u0026signature=vHyuOtsanX4HnY_0LNft6ZJ8C67JnbI8ZVCjA2d9nR0Rd6lCl0Nk1s6BAhefbBkzecX9Yp0B8NWN9Q5v1Z4ICw","large":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_large_1.png?version=v1\u0026expires=1568239682\u0026signature=SzCLKJ5m_TKJPLlL9PMw-zW9wo5mVYEK1jCtHwWRwwEaNU2v4Aehy-YHtus3TFJIt8RD2M-0Y3MtCxHwhqSABg"},{"small":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_small_2.png?version=v1\u0026expires=1568239682\u0026signature=iElagODaOCkF_lCUxIw-lK50GhEU1ar_odmslCazZqD4Fsd_rQLx3M4Q5HzYWp4evfzuCoFvk4oAQVuIAaguAw","medium":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_medium_2.png?version=v1\u0026expires=1568239682\u0026signature=2vwvm_QsfmdtkAa-_F4uk-0yeUPRascyhfwOr-OX1ya9i_8gdFQAxMTrP-FfNBVSYFXeknFm6IUPJHggfgeiBg","large":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_large_2.png?version=v1\u0026expires=1568239682\u0026signature=NQf7tP9F4rP66S16hQ8duFpZSbTjaGBGK61Sr3H5D4CWtRyaPdoQlIpT2Jw-eKRcuYRkDEtQse_oWtL5gPqXDQ"},{"small":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_small_3.png?version=v1\u0026expires=1568239682\u0026signature=dbjFd44H9TyZsc3d0fqKon5e0GqZ6GA1dT26MH6WnoX8lrQor2CA6sZJ5qmu0Z4SAFlMKAzb-twqN7faLjEbDQ","medium":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_medium_3.png?version=v1\u0026expires=1568239682\u0026signature=vSgwVs7T9E6KKBK7XU-6jRL9i0jvgTqvNxkdRARFf0UNlryJFm8l_t_x5mPH0sCTFZcLp7ouRaR5hhdHC6vZBQ","large":"https://lob-assets.com/checks/chk_92b9a6714bc0557c_thumb_large_3.png?version=v1\u0026expires=1568239682\u0026signature=If4tXlN13WYy7JDPpFkWw0HAQpYNJHqi2UstiPHxUA_8IAj6vXORb-22acI124Pd1bR1QSjBHAW1gbiJ0kjiAQ"}],"merge_variables":null,"expected_delivery_date":"2019-08-16","mail_type":"usps_first_class","date_created":"2019-08-08T19:34:27.802Z","date_modified":"2019-08-08T19:34:30.582Z","send_date":"2019-08-08T19:34:27.802Z","object":"check"}],"object":"list","next_url":"https://api.lob.com/v1/checks?limit=2\u0026after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wOFQxOTozNDoyNy44MDJaIiwiaWRPZmZzZXQiOiJjaGtfOTJiOWE2NzE0YmMwNTU3YyJ9","previous_url":null,"count":2}