v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Fetch the documents for a specified time range

get/v2/documents

Query parameters

ids[]integer[]

Specify the IDs of the documents that you want to fetch.

document_form_idinteger

Specify the Document Form ID.

categorystring

Denotes the category of the document. NOTe: This field is case sensitive and must match the exact category of the document.

uploader_idinteger

Specify the ID of the uploader whose document you want to fetch.

created_afterstring date

Specify the date and time after which the document was created. <ul><li>NOTE: The created_after parameter defaults to documents that were created 1 week before. This has been done reduce the data load in the response. So, if you are querying for documents that were created more than a week before, ensure to mention the specific date. </li></ul>

created_beforestring date

Specify the date and time before which the document was created.

per_pageinteger

Number of records to display per page.

page_nointeger

The current page numbner.

statusstring

Status of the document to return. Accepted value is 'archived' or omit this parameter

updated_afterstring date

Specify the date and time when the documents were updated. This will allow you to include all the documents that were updated after the specified date and time. For example, you may have updated a Bill of Lading on 1st of January 2025. To include such documents in the response, include the updated_after query to fetch all the available and updated bills.

Response

200

Example response

{
  "documents": [
    {
      "document": {
        "id": 13992544,
        "category": "notes",
        "ref_no": "notes",
        "doc_date": "2021-01-01",
        "doc_fields": "{\"notes\":\"notes\"}",
        "document_form_id": 143,
        "uploader": {
          "id": 1044876,
          "first_name": "John",
          "last_name": "Doe",
          "email": "john@email.com",
          "role": "dispatcher"
        },
        "created_at": "2021-10-12T17:32:19Z",
        "updated_at": "2021-10-12T17:32:19.638882Z"
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 1
  }
}