Documents

Filter documents

Changed on

Search 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" } } }
post/documents/filter

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/documents/filter
  • Auth: HTTP bearer

Request body

pageSizeinteger

Number of results per page

cursorstring

Pagination cursor from previous response

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_MANIFEST of the request property //

    • breaking

      removed the enum value AIR_CARGO_MANIFEST of the request property ///

    • breaking

      removed the enum value AIR_CARGO_MANIFEST of the request property //

    • breaking

      removed the enum value AIR_CARGO_MANIFEST of the request property ///

    • breaking

      removed the enum value AIR_CHUTE of the request property //

    • breaking

      removed the enum value AIR_CHUTE of the request property ///

    • breaking

      removed the enum value AIR_CHUTE of the request property //

    • breaking

      removed the enum value AIR_CHUTE of the request property ///

    • breaking

      removed the enum value AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPT of the request property //

    • breaking

      removed the enum value AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPT of the request property ///

    • breaking

      removed the enum value AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPT of the request property //

    • breaking

      removed the enum value AIR_FREIGHT_DEPARTURE_CARTAGE_ADVICE_WITH_RECEIPT of the request property ///

    • breaking

      removed the enum value AUTHORITY of the request property //

    • breaking

      removed the enum value AUTHORITY of the request property ///

    • breaking

      removed the enum value AUTHORITY of the request property //

    • breaking

      removed the enum value AUTHORITY of the request property ///

    • breaking

      removed the enum value AUTHORITY_TO_MAKE_ENTRY of the request property //

    • breaking

      removed the enum value AUTHORITY_TO_MAKE_ENTRY of the request property ///

    • breaking

      removed the enum value AUTHORITY_TO_MAKE_ENTRY of the request property //

    • breaking

      removed the enum value AUTHORITY_TO_MAKE_ENTRY of the request property ///

    • breaking

      removed the enum value BILL_OF_LADING of the request property //

    • breaking

      removed the enum value BILL_OF_LADING of the request property ///

    • breaking

      removed the enum value BILL_OF_LADING of the request property //

    • breaking

      removed the enum value BILL_OF_LADING of the request property ///

    • breaking

      removed the enum value BROKER_CARRIER_AGREEMENT of the request property //

    • breaking

      removed the enum value BROKER_CARRIER_AGREEMENT of the request property ///

    • breaking

      removed the enum value BROKER_CARRIER_AGREEMENT of the request property //

    • breaking

      removed the enum value BROKER_CARRIER_AGREEMENT of the request property ///

    • breaking

      removed the enum value CARRIER_INVOICE of the request property //

    • breaking

      removed the enum value CARRIER_INVOICE of the request property ///

    • breaking

      removed the enum value CARRIER_INVOICE of the request property //

    • breaking

      removed the enum value CARRIER_INVOICE of the request property ///

    • breaking

      removed the enum value CERTIFICATE_OF_INSURANCE of the request property //

    • breaking

      removed the enum value CERTIFICATE_OF_INSURANCE of the request property ///

    • breaking

      removed the enum value CERTIFICATE_OF_INSURANCE of the request property //

    • breaking

      removed the enum value CERTIFICATE_OF_INSURANCE of the request property ///

    • breaking

      removed the enum value COI_AUTO of the request property //

    • breaking

      removed the enum value COI_AUTO of the request property ///

    • breaking

      removed the enum value COI_AUTO of the request property //

    • breaking

      removed the enum value COI_AUTO of the request property ///

    • breaking

      removed the enum value COI_BIPD of the request property //

    • breaking

      removed the enum value COI_BIPD of the request property ///

    • breaking

      removed the enum value COI_BIPD of the request property //

    • breaking

      removed the enum value COI_BIPD of the request property ///

    • breaking

      removed the enum value COI_CARGO of the request property //

    • breaking

      removed the enum value COI_CARGO of the request property ///

    • breaking

      removed the enum value COI_CARGO of the request property //

    • breaking

      removed the enum value COI_CARGO of the request property ///

    • breaking

      removed the enum value COMMERCIAL_DRIVERS_LICENSE of the request property //

    • breaking

      removed the enum value COMMERCIAL_DRIVERS_LICENSE of the request property ///

    • breaking

      removed the enum value COMMERCIAL_DRIVERS_LICENSE of the request property //

    • breaking

      removed the enum value COMMERCIAL_DRIVERS_LICENSE of the request property ///

    • breaking

      removed the enum value COMMERCIAL_INVOICE of the request property //

    • breaking

      removed the enum value COMMERCIAL_INVOICE of the request property ///

    • breaking

      removed the enum value COMMERCIAL_INVOICE of the request property //

    • breaking

      removed the enum value COMMERCIAL_INVOICE of the request property ///

    • breaking

      removed the enum value CUSTOMER_ACCESSORIAL_SCHEDULE of the request property //

    • breaking

      removed the enum value CUSTOMER_ACCESSORIAL_SCHEDULE of the request property ///

    • breaking

      removed the enum value CUSTOMER_ACCESSORIAL_SCHEDULE of the request property //

    • breaking

      removed the enum value CUSTOMER_ACCESSORIAL_SCHEDULE of the request property ///

    • breaking

      removed the enum value CUSTOMER_AGREEMENT of the request property //

    • breaking

      removed the enum value CUSTOMER_AGREEMENT of the request property ///

    • breaking

      removed the enum value CUSTOMER_AGREEMENT of the request property //

    • breaking

      removed the enum value CUSTOMER_AGREEMENT of the request property ///

    • breaking

      removed the enum value CUSTOMER_AWARDED_BIDS of the request property //

    • breaking

      removed the enum value CUSTOMER_AWARDED_BIDS of the request property ///

    • breaking

      removed the enum value CUSTOMER_AWARDED_BIDS of the request property //

    • breaking

      removed the enum value CUSTOMER_AWARDED_BIDS of the request property ///

    • breaking

      removed the enum value CUSTOMER_AWARDED_RATES_LANES of the request property //

    • breaking

      removed the enum value CUSTOMER_AWARDED_RATES_LANES of the request property ///

    • breaking

      removed the enum value CUSTOMER_AWARDED_RATES_LANES of the request property //

    • breaking

      removed the enum value CUSTOMER_AWARDED_RATES_LANES of the request property ///

    • breaking

      removed the enum value CUSTOMER_CREDIT_REPORT of the request property //

    • breaking

      removed the enum value CUSTOMER_CREDIT_REPORT of the request property ///

    • breaking

      removed the enum value CUSTOMER_CREDIT_REPORT of the request property //

    • breaking

      removed the enum value CUSTOMER_CREDIT_REPORT of the request property ///

    • breaking

      removed the enum value DELIVERY_ALERT of the request property //

    • breaking

      removed the enum value DELIVERY_ALERT of the request property ///

    • breaking

      removed the enum value DELIVERY_ALERT of the request property //

    • breaking

      removed the enum value DELIVERY_ALERT of the request property ///

    • breaking

      removed the enum value DELIVERY_ORDER of the request property //

    • breaking

      removed the enum value DELIVERY_ORDER of the request property ///

    • breaking

      removed the enum value DELIVERY_ORDER of the request property //

    • breaking

      removed the enum value DELIVERY_ORDER of the request property ///

    • breaking

      removed the enum value DETENTION of the request property //

    • breaking

      removed the enum value DETENTION of the request property ///

    • breaking

      removed the enum value DETENTION of the request property //

    • breaking

      removed the enum value DETENTION of the request property ///

    • breaking

      removed the enum value FACTOR_NOTICE_OF_ASSIGNMENT of the request property //

    • breaking

      removed the enum value FACTOR_NOTICE_OF_ASSIGNMENT of the request property ///

    • breaking

      removed the enum value FACTOR_NOTICE_OF_ASSIGNMENT of the request property //

    • breaking

      removed the enum value FACTOR_NOTICE_OF_ASSIGNMENT of the request property ///

    • breaking

      removed the enum value FREIGHT_BILL of the request property //

    • breaking

      removed the enum value FREIGHT_BILL of the request property ///

    • breaking

      removed the enum value FREIGHT_BILL of the request property //

    • breaking

      removed the enum value FREIGHT_BILL of the request property ///

    • breaking

      removed the enum value FUEL_RECEIPT of the request property //

    • breaking

      removed the enum value FUEL_RECEIPT of the request property ///

    • breaking

      removed the enum value FUEL_RECEIPT of the request property //

    • breaking

      removed the enum value FUEL_RECEIPT of the request property ///

    • breaking

      removed the enum value GBL of the request property //

    • breaking

      removed the enum value GBL of the request property ///

    • breaking

      removed the enum value GBL of the request property //

    • breaking

      removed the enum value GBL of the request property ///

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL of the request property //

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL of the request property ///

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL of the request property //

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL of the request property ///

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL_MULTI of the request property //

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL_MULTI of the request property ///

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL_MULTI of the request property //

    • breaking

      removed the enum value HOUSE_AIRWAY_BILL_LABEL_MULTI of the request property ///

    • breaking

      removed the enum value IAC_CERTIFICATION of the request property //

    • breaking

      removed the enum value IAC_CERTIFICATION of the request property ///

    • breaking

      removed the enum value IAC_CERTIFICATION of the request property //

    • breaking

      removed the enum value IAC_CERTIFICATION of the request property ///

    • breaking

      removed the enum value INTERNATIONAL_HOUSE_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value INTERNATIONAL_HOUSE_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value INTERNATIONAL_HOUSE_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value INTERNATIONAL_HOUSE_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value INTERNATIONAL_MASTER_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value INTERNATIONAL_MASTER_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value INTERNATIONAL_MASTER_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value INTERNATIONAL_MASTER_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value INVOICE of the request property //

    • breaking

      removed the enum value INVOICE of the request property ///

    • breaking

      removed the enum value INVOICE of the request property //

    • breaking

      removed the enum value INVOICE of the request property ///

    • breaking

      removed the enum value LOAD_SUMMARY of the request property //

    • breaking

      removed the enum value LOAD_SUMMARY of the request property ///

    • breaking

      removed the enum value LOAD_SUMMARY of the request property //

    • breaking

      removed the enum value LOAD_SUMMARY of the request property ///

    • breaking

      removed the enum value LOAD_TENDER of the request property //

    • breaking

      removed the enum value LOAD_TENDER of the request property ///

    • breaking

      removed the enum value LOAD_TENDER of the request property //

    • breaking

      removed the enum value LOAD_TENDER of the request property ///

    • breaking

      removed the enum value LOG of the request property //

    • breaking

      removed the enum value LOG of the request property ///

    • breaking

      removed the enum value LOG of the request property //

    • breaking

      removed the enum value LOG of the request property ///

    • breaking

      removed the enum value LOGO of the request property //

    • breaking

      removed the enum value LOGO of the request property ///

    • breaking

      removed the enum value LOGO of the request property //

    • breaking

      removed the enum value LOGO of the request property ///

    • breaking

      removed the enum value LOGO_DOC of the request property //

    • breaking

      removed the enum value LOGO_DOC of the request property ///

    • breaking

      removed the enum value LOGO_DOC of the request property //

    • breaking

      removed the enum value LOGO_DOC of the request property ///

    • breaking

      removed the enum value LOGO_RECTANGLE of the request property //

    • breaking

      removed the enum value LOGO_RECTANGLE of the request property ///

    • breaking

      removed the enum value LOGO_RECTANGLE of the request property //

    • breaking

      removed the enum value LOGO_RECTANGLE of the request property ///

    • breaking

      removed the enum value LUMPER_RECEIPT of the request property //

    • breaking

      removed the enum value LUMPER_RECEIPT of the request property ///

    • breaking

      removed the enum value LUMPER_RECEIPT of the request property //

    • breaking

      removed the enum value LUMPER_RECEIPT of the request property ///

    • breaking

      removed the enum value MASTER_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value MASTER_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value MASTER_AIRWAY_BILL of the request property //

    • breaking

      removed the enum value MASTER_AIRWAY_BILL of the request property ///

    • breaking

      removed the enum value OTHER of the request property //

    • breaking

      removed the enum value OTHER of the request property ///

    • breaking

      removed the enum value OTHER of the request property //

    • breaking

      removed the enum value OTHER of the request property ///

    • breaking

      removed the enum value PACKING_LIST of the request property //

    • breaking

      removed the enum value PACKING_LIST of the request property ///

    • breaking

      removed the enum value PACKING_LIST of the request property //

    • breaking

      removed the enum value PACKING_LIST of the request property ///

    • breaking

      removed the enum value PHOTOGRAPH of the request property //

    • breaking

      removed the enum value PHOTOGRAPH of the request property ///

    • breaking

      removed the enum value PHOTOGRAPH of the request property //

    • breaking

      removed the enum value PHOTOGRAPH of the request property ///

    • breaking

      removed the enum value PROOF_OF_DELIVERY of the request property //

    • breaking

      removed the enum value PROOF_OF_DELIVERY of the request property ///

    • breaking

      removed the enum value PROOF_OF_DELIVERY of the request property //

    • breaking

      removed the enum value PROOF_OF_DELIVERY of the request property ///

    • breaking

      removed the enum value PROOF_OF_PERFORMANCE of the request property //

    • breaking

      removed the enum value PROOF_OF_PERFORMANCE of the request property ///

    • breaking

      removed the enum value PROOF_OF_PERFORMANCE of the request property //

    • breaking

      removed the enum value PROOF_OF_PERFORMANCE of the request property ///

    • breaking

      removed the enum value QUOTE of the request property //

    • breaking

      removed the enum value QUOTE of the request property ///

    • breaking

      removed the enum value QUOTE of the request property //

    • breaking

      removed the enum value QUOTE of the request property ///

    • breaking

      removed the enum value RATE_CON of the request property //

    • breaking

      removed the enum value RATE_CON of the request property ///

    • breaking

      removed the enum value RATE_CON of the request property //

    • breaking

      removed the enum value RATE_CON of the request property ///

    • breaking

      removed the enum value REEFER_KEYPAD of the request property //

    • breaking

      removed the enum value REEFER_KEYPAD of the request property ///

    • breaking

      removed the enum value REEFER_KEYPAD of the request property //

    • breaking

      removed the enum value REEFER_KEYPAD of the request property ///

    • breaking

      removed the enum value ROUTING_ALERT of the request property //

    • breaking

      removed the enum value ROUTING_ALERT of the request property ///

    • breaking

      removed the enum value ROUTING_ALERT of the request property //

    • breaking

      removed the enum value ROUTING_ALERT of the request property ///

    • breaking

      removed the enum value SCALE_RECEIPT of the request property //

    • breaking

      removed the enum value SCALE_RECEIPT of the request property ///

    • breaking

      removed the enum value SCALE_RECEIPT of the request property //

    • breaking

      removed the enum value SCALE_RECEIPT of the request property ///

    • breaking

      removed the enum value SEAL of the request property //

    • breaking

      removed the enum value SEAL of the request property ///

    • breaking

      removed the enum value SEAL of the request property //

    • breaking

      removed the enum value SEAL of the request property ///

    • breaking

      removed the enum value SHIPPING_LABEL of the request property //

    • breaking

      removed the enum value SHIPPING_LABEL of the request property ///

    • breaking

      removed the enum value SHIPPING_LABEL of the request property //

    • breaking

      removed the enum value SHIPPING_LABEL of the request property ///

    • breaking

      removed the enum value SIDE_OF_TRUCK of the request property //

    • breaking

      removed the enum value SIDE_OF_TRUCK of the request property ///

    • breaking

      removed the enum value SIDE_OF_TRUCK of the request property //

    • breaking

      removed the enum value SIDE_OF_TRUCK of the request property ///

    • breaking

      removed the enum value SIGNED_CARRIER_AGREEMENT of the request property //

    • breaking

      removed the enum value SIGNED_CARRIER_AGREEMENT of the request property ///

    • breaking

      removed the enum value SIGNED_CARRIER_AGREEMENT of the request property //

    • breaking

      removed the enum value SIGNED_CARRIER_AGREEMENT of the request property ///

    • breaking

      removed the enum value TRIP_SHEET of the request property //

    • breaking

      removed the enum value TRIP_SHEET of the request property ///

    • breaking

      removed the enum value TRIP_SHEET of the request property //

    • breaking

      removed the enum value TRIP_SHEET of the request property ///

    • breaking

      removed the enum value W9 of the request property //

    • breaking

      removed the enum value W9 of the request property ///

    • breaking

      removed the enum value W9 of the request property //

    • breaking

      removed the enum value W9 of the request property ///

    • breaking

      the / response's property type changed from object to 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 property anyOf list for the response status

    • breaking

      the response's body type changed from object to 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 #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for 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