List documents
GET/app/documents/
Authorization
X-API-KEYstring · headerrequired
Your company's API key.
Query parameters
expiredboolean
true returns only documents whose expiry date has already passed.
expiring_within_daysinteger
Only documents expiring within this many days from today, e.g. 30. Excludes ones that already expired.
expiry_end_datestring
Only documents expiring on or before this date (YYYY-MM-DD).
expiry_start_datestring
Only documents expiring on or after this date (YYYY-MM-DD).
pageinteger
A page number within the paginated result set.
page_sizeinteger
Number of results to return per page.
Response
200The record
countinteger
nextstring (uri)
previousstring (uri)
resultsarray of object
Show fields
idinteger
dot_modeboolean
document_ofstring
model_typestring
expiry_datestring (date)
namestring
document_typestring
doc_type_infostring
division_objstring
document_namestring
tags_objstring
document_statusstring
divisioninteger
object_idinteger
datestring (date)
documentstring (uri)
typestring
uploaded_by_driverboolean
rejectedboolean
rejection_reasonstring
company_namestring
descriptionstring
publicboolean
driverboolean
data_extraction_requestedboolean
data_extraction_successfulboolean
file_dropboolean
notestring
is_archivedboolean
is_snoozedboolean
unattachedboolean
tagged_modelenum
One of: Vehicle Trailer Driver -
is_deletedboolean
deleted_atstring (date-time)
created_atstring (date-time)
updated_atstring (date-time)
content_typeinteger
doc_typeinteger
uploaded_byinteger
tagsarray of integer