DOCUMENTS

Get Document List

Retrieve a paginated list of documents. Filter by submission, update or mailing date, document ID, document name, or status.

Class: documents

Method: get-document-list

POST/documents/get-document-list

Parameters

  • client_id*
  • akey*
  • page - Page number to retrieve. Defaults to 1
  • per_page - Number of results per page, up to a maximum of 50
  • date_submitted_from - used in combination with the to field for a Date Submitted range filter (mm/dd/yyyy format)
  • date_submitted_to - used in combination with the from field for a Date Submitted range filter (mm/dd/yyyy format)
  • date_updated_from - used in combination with the to field for a Date Updated range filter (mm/dd/yyyy format)
  • date_updated_to - used in combination with the from field for a Date Updated range filter (mm/dd/yyyy format)
  • date_sent_from - used in combination with the to field for a Date Sent range filter (mm/dd/yyyy format)
  • date_sent_to - used in combination with the from field for a Date Sent range filter (mm/dd/yyyy format)
  • id - search by numeric Document ID
  • document_name - search by Document Name string
  • status_id - Status ID to filter by, numeric only
    • 1 - Pending Release
    • 2 - Released
    • 3 - Processing
    • 4 - Sent Out
    • 5 - Returned
    • 6 - Rejected

JSON response

JSONResponse example
{
  "page_data": {
    "page": 1,
    "page_count": 1,
    "per_page": 50,
    "document_count": "2"
  },
  "documents": [
    {
      "id": "1",
      "confirmed": true,
      "document_type": "single",
      "print_type": "black_white",
      "mail_to": "Harbor Office Supply LLC",
      "address": "1250 Market Street",
      "address2": "",
      "city": "Denver",
      "state": "CO",
      "zip": "80202",
      "country": "US",
      "trans_id": "PAY-2026-001042",
      "address_position_type": "double_top_left",
      "document_return_address_option": "custom",
      "document_return_address": "Northstar Supply Co.|1800 Meridian Avenue|Suite 200|Denver, CO 80202",
      "fees": "0.15",
      "postage_fees": "0.60",
      "date_submittted": "07/12/2022",
      "date_updated": "07/14/2023",
      "date_sent": "07/14/2023",
      "status": {
        "id": "4",
        "name": "Sent Out"
      }
    },
    {
      "id": "2",
      "confirmed": true,
      "document_type": "single",
      "print_type": "black_white_duplex",
      "mail_to": "Summit Logistics LLC",
      "address": "4800 Innovation Drive",
      "address2": "",
      "city": "Denver",
      "state": "CO",
      "zip": "80202",
      "country": "US",
      "trans_id": "PAY-2026-001043",
      "address_position_type": "single_top_left",
      "document_return_address_option": "smartpayables",
      "document_return_address": "",
      "fees": "1.00",
      "postage_fees": "0.51",
      "date_submittted": "07/12/2022",
      "date_updated": "07/14/2023",
      "date_sent": "07/14/2023",
      "status": {
        "id": "4",
        "name": "Sent Out"
      }
    }
  ]
}

XML response

XMLResponse example
<?xml version="1.0" encoding="UTF-8"?>
<wmc-response status="1">
	<page_data>
		<page>1</page>
		<page_count>1</page_count>	
		<per_page>50</per_page>
		<document_count>2</document_count>
	</page_data>
	<documents>
		<document id='1' status='4'>
			<id>1</id>
			<date_submitted>1657639626</date_submitted>
			<date_updated>1689316841</date_updated>
			<date_sent>1689316841</date_sent>
			<confirmed>1</confirmed>
			<document_type>single</document_type>
			<print_type>black_white</print_type>
			<mail_to>Harbor Office Supply LLC</mail_to>
			<address>1250 Market Street</address>
			<address2></address2>
			<city>Denver</city>
			<state>CO</state>
			<zip>80202</zip>
			<country>US</country>
			<trans_id>PAY-2026-001042</trans_id>
			<address_position_type>double_top_left</address_position_type>
			<document_return_address_option>custom</document_return_address_option>
			<document_return_address>Northstar Supply Co.|1800 Meridian Avenue|Suite 200|Denver, CO 80202</document_return_address>
			<status_id>4</status_id>
			<fees>0.15</fees>
			<postage_fees>0.60</postage_fees>
		</document>
		<document id='2' status='4'>
			<id>2</id>
			<date_submitted>1657639626</date_submitted>
			<date_updated>1689316841</date_updated>
			<date_sent>1689316841</date_sent>
			<confirmed>1</confirmed>
			<document_type>single</document_type>
			<print_type>black_white</print_type>
			<mail_to>Summit Logistics LLC</mail_to>
			<address>4800 Innovation Drive</address>
			<address2></address2>
			<city>Denver</city>
			<state>CO</state>
			<zip>80202</zip>
			<country>US</country>
			<trans_id>PAY-2026-001043</trans_id>
			<address_position_type>single_top_left</address_position_type>
			<envelope_type_id>5</envelope_type_id>
			<status_id>4</status_id>
			<fees>0.45</fees>
			<postage_fees>0.67</postage_fees>
		</document>
	</documents>
</wmc-response>

Search documentation