Filter documents
Changed onSearch file metadata, or list resource attachment mappings. With resourceType/resourceId, type filters apply to each matching relationship and shared files retain separate rows. Without a resource scope, type filters retain base file-category semantics. Supply resourceType and resourceId together at the top level. Shipment scope includes order, load and service documents.
Usage
Documents are typically associated with other entities (orders, loads, services). Use filters to find documents by type, status, or date range.
Example Filters
- Find all invoices: { "filter": { "type": { "equalTo": "INVOICE" } } }
- Find uploaded documents: { "filter": { "status": { "equalTo": "UPLOADED" } } }
- Find documents created today: { "filter": { "createdAt": { "greaterThanOrEqualTo": "2025-01-15T00:00:00Z" } } }
Request
- Base URL: https://api.mvmnt.io/v1
- URL: https://api.mvmnt.io/v1/documents/filter
- Auth: HTTP bearer
Request body
Response
Documents matching filter criteria
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "doc-inv-2025-001",
"fileName": "invoice-2025-001.pdf",
"extension": "pdf",
"contentType": "application/pdf",
"fileSize": 102400,
"uploadUrl": "https://s3.amazonaws.com/bucket/key?signature=...",
"downloadUrl": "https://s3.amazonaws.com/bucket/key?signature=...",
"tags": {
"invoiceNumber": "INV-2025-001",
"customerPO": "PO-12345"
},
"createdAt": "2025-01-15T10:30:00Z",
"updatedAt": "2025-01-15T10:35:00Z"
}
],
"pagination": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
},
"errors": [
{
"field": "/required",
"message": "missing property 'status'"
}
]
}Changes
- breaking
removed the enum value
AIR_CARGO_MANIFESTof the request property// - breaking
removed the enum value
AIR_CARGO_MANIFESTof the request property/// - breaking
removed the enum value
AIR_CARGO_MANIFESTof the request property// - breaking
removed the enum value
AIR_CARGO_MANIFESTof the request property/// - breaking
removed the enum value
AIR_CHUTEof the request property// - breaking
removed the enum value
AIR_CHUTEof the request property/// - breaking
removed the enum value
AIR_CHUTEof the request property// - breaking
removed the enum value
AIR_CHUTEof the request property/// - breaking
removed the enum value
AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPTof the request property// - breaking
removed the enum value
AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPTof the request property/// - breaking
removed the enum value
AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPTof the request property// - breaking
removed the enum value
AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPTof the request property/// - breaking
removed the enum value
AUTHORITYof the request property// - breaking
removed the enum value
AUTHORITYof the request property/// - breaking
removed the enum value
AUTHORITYof the request property// - breaking
removed the enum value
AUTHORITYof the request property/// - breaking
removed the enum value
AUTHORITY_TO_MAKE_ENTRYof the request property// - breaking
removed the enum value
AUTHORITY_TO_MAKE_ENTRYof the request property/// - breaking
removed the enum value
AUTHORITY_TO_MAKE_ENTRYof the request property// - breaking
removed the enum value
AUTHORITY_TO_MAKE_ENTRYof the request property/// - breaking
removed the enum value
BILL_OF_LADINGof the request property// - breaking
removed the enum value
BILL_OF_LADINGof the request property/// - breaking
removed the enum value
BILL_OF_LADINGof the request property// - breaking
removed the enum value
BILL_OF_LADINGof the request property/// - breaking
removed the enum value
BROKER_CARRIER_AGREEMENTof the request property// - breaking
removed the enum value
BROKER_CARRIER_AGREEMENTof the request property/// - breaking
removed the enum value
BROKER_CARRIER_AGREEMENTof the request property// - breaking
removed the enum value
BROKER_CARRIER_AGREEMENTof the request property/// - breaking
removed the enum value
CARRIER_INVOICEof the request property// - breaking
removed the enum value
CARRIER_INVOICEof the request property/// - breaking
removed the enum value
CARRIER_INVOICEof the request property// - breaking
removed the enum value
CARRIER_INVOICEof the request property/// - breaking
removed the enum value
CERTIFICATE_OF_INSURANCEof the request property// - breaking
removed the enum value
CERTIFICATE_OF_INSURANCEof the request property/// - breaking
removed the enum value
CERTIFICATE_OF_INSURANCEof the request property// - breaking
removed the enum value
CERTIFICATE_OF_INSURANCEof the request property/// - breaking
removed the enum value
COI_AUTOof the request property// - breaking
removed the enum value
COI_AUTOof the request property/// - breaking
removed the enum value
COI_AUTOof the request property// - breaking
removed the enum value
COI_AUTOof the request property/// - breaking
removed the enum value
COI_BIPDof the request property// - breaking
removed the enum value
COI_BIPDof the request property/// - breaking
removed the enum value
COI_BIPDof the request property// - breaking
removed the enum value
COI_BIPDof the request property/// - breaking
removed the enum value
COI_CARGOof the request property// - breaking
removed the enum value
COI_CARGOof the request property/// - breaking
removed the enum value
COI_CARGOof the request property// - breaking
removed the enum value
COI_CARGOof the request property/// - breaking
removed the enum value
COMMERCIAL_DRIVERS_LICENSEof the request property// - breaking
removed the enum value
COMMERCIAL_DRIVERS_LICENSEof the request property/// - breaking
removed the enum value
COMMERCIAL_DRIVERS_LICENSEof the request property// - breaking
removed the enum value
COMMERCIAL_DRIVERS_LICENSEof the request property/// - breaking
removed the enum value
COMMERCIAL_INVOICEof the request property// - breaking
removed the enum value
COMMERCIAL_INVOICEof the request property/// - breaking
removed the enum value
COMMERCIAL_INVOICEof the request property// - breaking
removed the enum value
COMMERCIAL_INVOICEof the request property/// - breaking
removed the enum value
CUSTOMER_ACCESSORIAL_SCHEDULEof the request property// - breaking
removed the enum value
CUSTOMER_ACCESSORIAL_SCHEDULEof the request property/// - breaking
removed the enum value
CUSTOMER_ACCESSORIAL_SCHEDULEof the request property// - breaking
removed the enum value
CUSTOMER_ACCESSORIAL_SCHEDULEof the request property/// - breaking
removed the enum value
CUSTOMER_AGREEMENTof the request property// - breaking
removed the enum value
CUSTOMER_AGREEMENTof the request property/// - breaking
removed the enum value
CUSTOMER_AGREEMENTof the request property// - breaking
removed the enum value
CUSTOMER_AGREEMENTof the request property/// - breaking
removed the enum value
CUSTOMER_AWARDED_BIDSof the request property// - breaking
removed the enum value
CUSTOMER_AWARDED_BIDSof the request property/// - breaking
removed the enum value
CUSTOMER_AWARDED_BIDSof the request property// - breaking
removed the enum value
CUSTOMER_AWARDED_BIDSof the request property/// - breaking
removed the enum value
CUSTOMER_AWARDED_RATES_LANESof the request property// - breaking
removed the enum value
CUSTOMER_AWARDED_RATES_LANESof the request property/// - breaking
removed the enum value
CUSTOMER_AWARDED_RATES_LANESof the request property// - breaking
removed the enum value
CUSTOMER_AWARDED_RATES_LANESof the request property/// - breaking
removed the enum value
CUSTOMER_CREDIT_REPORTof the request property// - breaking
removed the enum value
CUSTOMER_CREDIT_REPORTof the request property/// - breaking
removed the enum value
CUSTOMER_CREDIT_REPORTof the request property// - breaking
removed the enum value
CUSTOMER_CREDIT_REPORTof the request property/// - breaking
removed the enum value
DELIVERY_ALERTof the request property// - breaking
removed the enum value
DELIVERY_ALERTof the request property/// - breaking
removed the enum value
DELIVERY_ALERTof the request property// - breaking
removed the enum value
DELIVERY_ALERTof the request property/// - breaking
removed the enum value
DELIVERY_ORDERof the request property// - breaking
removed the enum value
DELIVERY_ORDERof the request property/// - breaking
removed the enum value
DELIVERY_ORDERof the request property// - breaking
removed the enum value
DELIVERY_ORDERof the request property/// - breaking
removed the enum value
DETENTIONof the request property// - breaking
removed the enum value
DETENTIONof the request property/// - breaking
removed the enum value
DETENTIONof the request property// - breaking
removed the enum value
DETENTIONof the request property/// - breaking
removed the enum value
FACTOR_NOTICE_OF_ASSIGNMENTof the request property// - breaking
removed the enum value
FACTOR_NOTICE_OF_ASSIGNMENTof the request property/// - breaking
removed the enum value
FACTOR_NOTICE_OF_ASSIGNMENTof the request property// - breaking
removed the enum value
FACTOR_NOTICE_OF_ASSIGNMENTof the request property/// - breaking
removed the enum value
FREIGHT_BILLof the request property// - breaking
removed the enum value
FREIGHT_BILLof the request property/// - breaking
removed the enum value
FREIGHT_BILLof the request property// - breaking
removed the enum value
FREIGHT_BILLof the request property/// - breaking
removed the enum value
FUEL_RECEIPTof the request property// - breaking
removed the enum value
FUEL_RECEIPTof the request property/// - breaking
removed the enum value
FUEL_RECEIPTof the request property// - breaking
removed the enum value
FUEL_RECEIPTof the request property/// - breaking
removed the enum value
GBLof the request property// - breaking
removed the enum value
GBLof the request property/// - breaking
removed the enum value
GBLof the request property// - breaking
removed the enum value
GBLof the request property/// - breaking
removed the enum value
HOUSE_AIRWAY_BILLof the request property// - breaking
removed the enum value
HOUSE_AIRWAY_BILLof the request property/// - breaking
removed the enum value
HOUSE_AIRWAY_BILLof the request property// - breaking
removed the enum value
HOUSE_AIRWAY_BILLof the request property/// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABELof the request property// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABELof the request property/// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABELof the request property// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABELof the request property/// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABEL_MULTIof the request property// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABEL_MULTIof the request property/// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABEL_MULTIof the request property// - breaking
removed the enum value
HOUSE_AIRWAY_BILL_LABEL_MULTIof the request property/// - breaking
removed the enum value
IAC_CERTIFICATIONof the request property// - breaking
removed the enum value
IAC_CERTIFICATIONof the request property/// - breaking
removed the enum value
IAC_CERTIFICATIONof the request property// - breaking
removed the enum value
IAC_CERTIFICATIONof the request property/// - breaking
removed the enum value
INTERNATIONAL_HOUSE_AIRWAY_BILLof the request property// - breaking
removed the enum value
INTERNATIONAL_HOUSE_AIRWAY_BILLof the request property/// - breaking
removed the enum value
INTERNATIONAL_HOUSE_AIRWAY_BILLof the request property// - breaking
removed the enum value
INTERNATIONAL_HOUSE_AIRWAY_BILLof the request property/// - breaking
removed the enum value
INTERNATIONAL_MASTER_AIRWAY_BILLof the request property// - breaking
removed the enum value
INTERNATIONAL_MASTER_AIRWAY_BILLof the request property/// - breaking
removed the enum value
INTERNATIONAL_MASTER_AIRWAY_BILLof the request property// - breaking
removed the enum value
INTERNATIONAL_MASTER_AIRWAY_BILLof the request property/// - breaking
removed the enum value
INVOICEof the request property// - breaking
removed the enum value
INVOICEof the request property/// - breaking
removed the enum value
INVOICEof the request property// - breaking
removed the enum value
INVOICEof the request property/// - breaking
removed the enum value
LOAD_SUMMARYof the request property// - breaking
removed the enum value
LOAD_SUMMARYof the request property/// - breaking
removed the enum value
LOAD_SUMMARYof the request property// - breaking
removed the enum value
LOAD_SUMMARYof the request property/// - breaking
removed the enum value
LOAD_TENDERof the request property// - breaking
removed the enum value
LOAD_TENDERof the request property/// - breaking
removed the enum value
LOAD_TENDERof the request property// - breaking
removed the enum value
LOAD_TENDERof the request property/// - breaking
removed the enum value
LOGof the request property// - breaking
removed the enum value
LOGof the request property/// - breaking
removed the enum value
LOGof the request property// - breaking
removed the enum value
LOGof the request property/// - breaking
removed the enum value
LOGOof the request property// - breaking
removed the enum value
LOGOof the request property/// - breaking
removed the enum value
LOGOof the request property// - breaking
removed the enum value
LOGOof the request property/// - breaking
removed the enum value
LOGO_DOCof the request property// - breaking
removed the enum value
LOGO_DOCof the request property/// - breaking
removed the enum value
LOGO_DOCof the request property// - breaking
removed the enum value
LOGO_DOCof the request property/// - breaking
removed the enum value
LOGO_RECTANGLEof the request property// - breaking
removed the enum value
LOGO_RECTANGLEof the request property/// - breaking
removed the enum value
LOGO_RECTANGLEof the request property// - breaking
removed the enum value
LOGO_RECTANGLEof the request property/// - breaking
removed the enum value
LUMPER_RECEIPTof the request property// - breaking
removed the enum value
LUMPER_RECEIPTof the request property/// - breaking
removed the enum value
LUMPER_RECEIPTof the request property// - breaking
removed the enum value
LUMPER_RECEIPTof the request property/// - breaking
removed the enum value
MASTER_AIRWAY_BILLof the request property// - breaking
removed the enum value
MASTER_AIRWAY_BILLof the request property/// - breaking
removed the enum value
MASTER_AIRWAY_BILLof the request property// - breaking
removed the enum value
MASTER_AIRWAY_BILLof the request property/// - breaking
removed the enum value
OTHERof the request property// - breaking
removed the enum value
OTHERof the request property/// - breaking
removed the enum value
OTHERof the request property// - breaking
removed the enum value
OTHERof the request property/// - breaking
removed the enum value
PACKING_LISTof the request property// - breaking
removed the enum value
PACKING_LISTof the request property/// - breaking
removed the enum value
PACKING_LISTof the request property// - breaking
removed the enum value
PACKING_LISTof the request property/// - breaking
removed the enum value
PHOTOGRAPHof the request property// - breaking
removed the enum value
PHOTOGRAPHof the request property/// - breaking
removed the enum value
PHOTOGRAPHof the request property// - breaking
removed the enum value
PHOTOGRAPHof the request property/// - breaking
removed the enum value
PROOF_OF_DELIVERYof the request property// - breaking
removed the enum value
PROOF_OF_DELIVERYof the request property/// - breaking
removed the enum value
PROOF_OF_DELIVERYof the request property// - breaking
removed the enum value
PROOF_OF_DELIVERYof the request property/// - breaking
removed the enum value
PROOF_OF_PERFORMANCEof the request property// - breaking
removed the enum value
PROOF_OF_PERFORMANCEof the request property/// - breaking
removed the enum value
PROOF_OF_PERFORMANCEof the request property// - breaking
removed the enum value
PROOF_OF_PERFORMANCEof the request property/// - breaking
removed the enum value
QUOTEof the request property// - breaking
removed the enum value
QUOTEof the request property/// - breaking
removed the enum value
QUOTEof the request property// - breaking
removed the enum value
QUOTEof the request property/// - breaking
removed the enum value
RATE_CONof the request property// - breaking
removed the enum value
RATE_CONof the request property/// - breaking
removed the enum value
RATE_CONof the request property// - breaking
removed the enum value
RATE_CONof the request property/// - breaking
removed the enum value
REEFER_KEYPADof the request property// - breaking
removed the enum value
REEFER_KEYPADof the request property/// - breaking
removed the enum value
REEFER_KEYPADof the request property// - breaking
removed the enum value
REEFER_KEYPADof the request property/// - breaking
removed the enum value
ROUTING_ALERTof the request property// - breaking
removed the enum value
ROUTING_ALERTof the request property/// - breaking
removed the enum value
ROUTING_ALERTof the request property// - breaking
removed the enum value
ROUTING_ALERTof the request property/// - breaking
removed the enum value
SCALE_RECEIPTof the request property// - breaking
removed the enum value
SCALE_RECEIPTof the request property/// - breaking
removed the enum value
SCALE_RECEIPTof the request property// - breaking
removed the enum value
SCALE_RECEIPTof the request property/// - breaking
removed the enum value
SEALof the request property// - breaking
removed the enum value
SEALof the request property/// - breaking
removed the enum value
SEALof the request property// - breaking
removed the enum value
SEALof the request property/// - breaking
removed the enum value
SHIPPING_LABELof the request property// - breaking
removed the enum value
SHIPPING_LABELof the request property/// - breaking
removed the enum value
SHIPPING_LABELof the request property// - breaking
removed the enum value
SHIPPING_LABELof the request property/// - breaking
removed the enum value
SIDE_OF_TRUCKof the request property// - breaking
removed the enum value
SIDE_OF_TRUCKof the request property/// - breaking
removed the enum value
SIDE_OF_TRUCKof the request property// - breaking
removed the enum value
SIDE_OF_TRUCKof the request property/// - breaking
removed the enum value
SIGNED_CARRIER_AGREEMENTof the request property// - breaking
removed the enum value
SIGNED_CARRIER_AGREEMENTof the request property/// - breaking
removed the enum value
SIGNED_CARRIER_AGREEMENTof the request property// - breaking
removed the enum value
SIGNED_CARRIER_AGREEMENTof the request property/// - breaking
removed the enum value
TRIP_SHEETof the request property// - breaking
removed the enum value
TRIP_SHEETof the request property/// - breaking
removed the enum value
TRIP_SHEETof the request property// - breaking
removed the enum value
TRIP_SHEETof the request property/// - breaking
removed the enum value
W9of the request property// - breaking
removed the enum value
W9of the request property/// - breaking
removed the enum value
W9of the request property// - breaking
removed the enum value
W9of the request property/// - breaking
the
/response's property type changed fromobjectto no type for status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - info
added the new optional request property
/ - info
added the new optional request property
/ - info
added the non-success response with the status
- info
added to the
/response propertyanyOflist for the response status
- breaking
- breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - info
added
subschema #2to the response bodyallOflist for the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking