---
title: "Search Documents"
method: POST
path: "/services/document/v1/documents/search"
tags: ["Multi-Modal: Document"]
---

# Search Documents

`POST /services/document/v1/documents/search`

## Request

- Base URL: `https://na12.api.project44.com`
- URL: `https://na12.api.project44.com/services/document/v1/documents/search`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/v4/oauth2/token`
- TypeScript: <https://skmtc.dev/project44/apis/project44-rest-api/docs/services/document/v1/documents/search/post.ts> (a function with typed inputs; its response is checked against the schema)

Get documents

## Query parameters

- `page` integer
- `size` integer

## Request body

- BodySearchDocumentsDocumentsSearchPost
  - `identifiers` IdentifierWrapper
    - `operator` 'EQUALS' | 'NOT_EQUALS' | 'CONTAINS': An enumeration.
    - `values` Identifier[]: List of logistics identifiers to search for
      - `type` union: The identifier type that can identify this entity.
        - 'AIR_WAYBILL' | 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'BOOKING_NUMBER' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_NAME' | 'CARRIER_SCAC' | 'FFW_SCAC' | 'CONTAINER_ID' | 'CUSTOMER_REFERENCE' | 'DELIVERY_NUMBER' | 'EXTERNAL' | 'FLIGHT_NUMBER' | 'ORDER' | 'PICKUP' | 'PRO' | 'PURCHASE_ORDER' | 'RAIL_CAR_ID' | 'RAIL_WAYBILL' | 'TRACKING_NUMBER' | 'TRAILER_ID' | 'UNKNOWN' | 'VESSEL_IMO' | 'VESSEL_NAME' | 'WAYBILL' | 'VESSEL_CALL_SIGN' | 'VESSEL_MMSI' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'SUBSCRIPTION_ID' | 'HOUSE_AIR_WAYBILL' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'VOYAGE_NUMBER' | 'CARRIER_MASTER_ID' | 'CARRIER_NMC_ID' | 'CONTAINER_TYPE' | 'TRAIN_NUMBER' | 'WAGON_ID' | 'CAPACITY_PROVIDER_ACCOUNT_GROUP' | 'CAPACITY_PROVIDER_ACCOUNT_CODE' | 'SERIAL_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER' | 'REFERENCE_NUMBER' | 'CONTAINER_PIN' | 'INVOICE_ID' | 'VESSEL_P44_ID': The type of identifier provided to distinguish the Shipment.
        - 'MASTER_SHIPMENT_ID' | 'BOOKING_ID' | 'STOP_ID' | 'DRIVER_ID' | 'TRUCKLOAD_TRACKING_ID' | 'ORDER_ID' | 'SHIPPER_TENANT_UUID': An enumeration.
      - `value` string: Identifier.
  - `name` NameWrapper
    - `operator` 'EQUALS' | 'NOT_EQUALS' | 'CONTAINS': An enumeration.
    - `value` string: The name of the document to search for
  - `type` TypeWrapper
    - `operator` 'EQUALS' | 'NOT_EQUALS' | 'CONTAINS': An enumeration.
    - `values` DocumentType[]: The list of document type to be search for

## Response `200`

Successful Response

- unknown

---

[API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)