POST
/
api
/
v1
/
documents
/
list
curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/list \
  --header 'Content-Type: application/json' \
  --data '{
  "latest_only": true,
  "limit": 10,
  "metadata_filter": {
    "$and": [
      {
        "category": "finance"
      },
      {
        "tags": {
          "$contains": [
            "important"
          ]
        }
      },
      {
        "$or": [
          {
            "priority": {
              "$gt": 2
            }
          },
          {
            "status": "active"
          }
        ]
      }
    ]
  },
  "offset": 0,
  "sort_field": "last_created_at",
  "sort_order": "desc"
}'
{
  "success": true,
  "data": {
    "documents": [
      {
        "id": 123,
        "external_id": "<string>",
        "file_path": "<string>",
        "document_metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "preview": "<string>"
      }
    ],
    "total": 123,
    "offset": 123,
    "limit": 123
  },
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Headers

​
X-API-Key
string | null

Body

application/json
​
metadata_filter
object | null

Metadata filters using MongoDB-like query syntax. Supports comparison, array, and logical operators

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
​
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100
​
sort_field
enum<string>

Field to sort by

Available options:
first_created_at,
last_created_at
​
sort_order
enum<string>

Sort order (ascending or descending)

Available options:
asc,
desc
​
latest_only
boolean
default:true

If True, returns only the latest version of each document

Response

200
application/json
Successful Response
​
data
object
required

Response data

​
success
boolean
default:true
​
error
object | null

Schema for API error responses.

Example:
{
  "error_code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found"
}
​
meta
object

Metadata for API responses