get https://api.gomotive.com/v2/documents
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.