Fetch the documents for a specified time range

Log in to see full request history

Purpose: Use this API to fetch a list of the documents as per a specified time range.

📘

NOTE

You must specify the following in the query parameters:

  • Document ID(s)
  • Document form ID
  • Category
  • Uploaded ID
  • Created after
  • Created before
  • Status
  • Updated at

Refer to the query parameter section for more info.


Response Parameter

documents

  • Type: Array of Objects
  • Description: A list of document details.

id

  • Type: Integer
  • Description: The unique identifier for the document.

category

  • Type: String
  • Description: The category of the document, e.g., "notes".

ref_no

  • Type: String
  • Description: The reference number associated with the document.

notes

  • Type: String
  • Description: Notes associated with the document.

doc_date

  • Type: Date (YYYY-MM-DD)
  • Description: The date associated with the document.

doc_fields

  • Type: String
  • Description: The fields associated with the document in JSON format.

doc_time

  • Type: DateTime (ISO 8601)
  • Description: The time associated with the document.

document_form_id

  • Type: Integer
  • Description: The unique identifier for the document form.

uploader

  • Type: Object
  • Description: The user who uploaded the document.

id

  • Type: Integer
  • Description: The unique identifier for the user who uploaded the document.

first_name

  • Type: String
  • Description: The first name of the user who uploaded the document.

last_name

  • Type: String
  • Description: The last name of the user who uploaded the document.

email

  • Type: String
  • Description: The email address of the user who uploaded the document.

role

  • Type: String
  • Description: The role of the user who uploaded the document, e.g., "dispatcher".

deactivated_at

  • Type: DateTime (ISO 8601)
  • Description: The timestamp when the uploader was deactivated.

driver_company_id

  • Type: Integer
  • Description: The unique identifier for the driver's company.

created_at

  • Type: DateTime (ISO 8601)
  • Description: The timestamp when the document was created.

updated_at

  • Type: DateTime (ISO 8601)
  • Description: The timestamp when the document was last updated.

Query Params
array of int32s

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

ids
int32

Specify the Document Form ID.

string

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

int32

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

date

Specify the date after which the document was created.

date

Specify the date before which the document was created.

int32
Defaults to 25

Number of records to display per page.

int32
Defaults to 1

The current page numbner.

string

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

string

Specify the time when the documents were updated. This will allow you to include all the documents that were updated after the specified time. For example, you may have created a Bill of Lading on 15th of November, and it was updated on 16th of November. To include such documents in the response, include the updated_at query to fetch all the available and updated bills.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json