curl --request POST \
--url https://api.fieldwise.ai/api/v1/documents/list \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"created_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
},
"document_ids": [
1,
2,
3
],
"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",
"updated_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
}
}
'import requests
url = "https://api.fieldwise.ai/api/v1/documents/list"
payload = {
"created_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
},
"document_ids": [1, 2, 3],
"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",
"updated_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
created_at_filter: {$gte: '2024-01-01T00:00:00', $lt: '2024-12-31T23:59:59'},
document_ids: [1, 2, 3],
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',
updated_at_filter: {$gte: '2024-01-01T00:00:00', $lt: '2024-12-31T23:59:59'}
})
};
fetch('https://api.fieldwise.ai/api/v1/documents/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldwise.ai/api/v1/documents/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'created_at_filter' => [
'$gte' => '2024-01-01T00:00:00',
'$lt' => '2024-12-31T23:59:59'
],
'document_ids' => [
1,
2,
3
],
'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',
'updated_at_filter' => [
'$gte' => '2024-01-01T00:00:00',
'$lt' => '2024-12-31T23:59:59'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fieldwise.ai/api/v1/documents/list"
payload := strings.NewReader("{\n \"created_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n },\n \"document_ids\": [\n 1,\n 2,\n 3\n ],\n \"latest_only\": true,\n \"limit\": 10,\n \"metadata_filter\": {\n \"$and\": [\n {\n \"category\": \"finance\"\n },\n {\n \"tags\": {\n \"$contains\": [\n \"important\"\n ]\n }\n },\n {\n \"$or\": [\n {\n \"priority\": {\n \"$gt\": 2\n }\n },\n {\n \"status\": \"active\"\n }\n ]\n }\n ]\n },\n \"offset\": 0,\n \"sort_field\": \"last_created_at\",\n \"sort_order\": \"desc\",\n \"updated_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fieldwise.ai/api/v1/documents/list")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"created_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n },\n \"document_ids\": [\n 1,\n 2,\n 3\n ],\n \"latest_only\": true,\n \"limit\": 10,\n \"metadata_filter\": {\n \"$and\": [\n {\n \"category\": \"finance\"\n },\n {\n \"tags\": {\n \"$contains\": [\n \"important\"\n ]\n }\n },\n {\n \"$or\": [\n {\n \"priority\": {\n \"$gt\": 2\n }\n },\n {\n \"status\": \"active\"\n }\n ]\n }\n ]\n },\n \"offset\": 0,\n \"sort_field\": \"last_created_at\",\n \"sort_order\": \"desc\",\n \"updated_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldwise.ai/api/v1/documents/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"created_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n },\n \"document_ids\": [\n 1,\n 2,\n 3\n ],\n \"latest_only\": true,\n \"limit\": 10,\n \"metadata_filter\": {\n \"$and\": [\n {\n \"category\": \"finance\"\n },\n {\n \"tags\": {\n \"$contains\": [\n \"important\"\n ]\n }\n },\n {\n \"$or\": [\n {\n \"priority\": {\n \"$gt\": 2\n }\n },\n {\n \"status\": \"active\"\n }\n ]\n }\n ]\n },\n \"offset\": 0,\n \"sort_field\": \"last_created_at\",\n \"sort_order\": \"desc\",\n \"updated_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"documents": [
{
"id": 123,
"external_id": "<string>",
"file_path": "<string>",
"document_metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"preview": "<string>"
}
],
"total": 123,
"offset": 123,
"limit": 123
},
"success": true,
"error": {
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0"
}
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}List Documents
curl --request POST \
--url https://api.fieldwise.ai/api/v1/documents/list \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"created_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
},
"document_ids": [
1,
2,
3
],
"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",
"updated_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
}
}
'import requests
url = "https://api.fieldwise.ai/api/v1/documents/list"
payload = {
"created_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
},
"document_ids": [1, 2, 3],
"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",
"updated_at_filter": {
"$gte": "2024-01-01T00:00:00",
"$lt": "2024-12-31T23:59:59"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
created_at_filter: {$gte: '2024-01-01T00:00:00', $lt: '2024-12-31T23:59:59'},
document_ids: [1, 2, 3],
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',
updated_at_filter: {$gte: '2024-01-01T00:00:00', $lt: '2024-12-31T23:59:59'}
})
};
fetch('https://api.fieldwise.ai/api/v1/documents/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldwise.ai/api/v1/documents/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'created_at_filter' => [
'$gte' => '2024-01-01T00:00:00',
'$lt' => '2024-12-31T23:59:59'
],
'document_ids' => [
1,
2,
3
],
'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',
'updated_at_filter' => [
'$gte' => '2024-01-01T00:00:00',
'$lt' => '2024-12-31T23:59:59'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fieldwise.ai/api/v1/documents/list"
payload := strings.NewReader("{\n \"created_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n },\n \"document_ids\": [\n 1,\n 2,\n 3\n ],\n \"latest_only\": true,\n \"limit\": 10,\n \"metadata_filter\": {\n \"$and\": [\n {\n \"category\": \"finance\"\n },\n {\n \"tags\": {\n \"$contains\": [\n \"important\"\n ]\n }\n },\n {\n \"$or\": [\n {\n \"priority\": {\n \"$gt\": 2\n }\n },\n {\n \"status\": \"active\"\n }\n ]\n }\n ]\n },\n \"offset\": 0,\n \"sort_field\": \"last_created_at\",\n \"sort_order\": \"desc\",\n \"updated_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fieldwise.ai/api/v1/documents/list")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"created_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n },\n \"document_ids\": [\n 1,\n 2,\n 3\n ],\n \"latest_only\": true,\n \"limit\": 10,\n \"metadata_filter\": {\n \"$and\": [\n {\n \"category\": \"finance\"\n },\n {\n \"tags\": {\n \"$contains\": [\n \"important\"\n ]\n }\n },\n {\n \"$or\": [\n {\n \"priority\": {\n \"$gt\": 2\n }\n },\n {\n \"status\": \"active\"\n }\n ]\n }\n ]\n },\n \"offset\": 0,\n \"sort_field\": \"last_created_at\",\n \"sort_order\": \"desc\",\n \"updated_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldwise.ai/api/v1/documents/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"created_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n },\n \"document_ids\": [\n 1,\n 2,\n 3\n ],\n \"latest_only\": true,\n \"limit\": 10,\n \"metadata_filter\": {\n \"$and\": [\n {\n \"category\": \"finance\"\n },\n {\n \"tags\": {\n \"$contains\": [\n \"important\"\n ]\n }\n },\n {\n \"$or\": [\n {\n \"priority\": {\n \"$gt\": 2\n }\n },\n {\n \"status\": \"active\"\n }\n ]\n }\n ]\n },\n \"offset\": 0,\n \"sort_field\": \"last_created_at\",\n \"sort_order\": \"desc\",\n \"updated_at_filter\": {\n \"$gte\": \"2024-01-01T00:00:00\",\n \"$lt\": \"2024-12-31T23:59:59\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"documents": [
{
"id": 123,
"external_id": "<string>",
"file_path": "<string>",
"document_metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"preview": "<string>"
}
],
"total": 123,
"offset": 123,
"limit": 123
},
"success": true,
"error": {
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0"
}
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}Authorizations
Headers
Body
Specific document IDs to retrieve. When provided, ignores metadata_filter and latest_only parameters.
Metadata filters using MongoDB-like query syntax. Supports comparison, array, and logical operators
Filter by created_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')
Filter by updated_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')
Number of items to skip
x >= 0Maximum number of items to return
1 <= x <= 100Field to sort by
first_created_at, last_created_at Sort order (ascending or descending)
asc, desc If True, returns only the latest version of each document
Response
Successful Response
Response data
Show child attributes
Show child attributes
Schema for API error responses.
Show child attributes
Show child attributes
{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}
Metadata for API responses
Show child attributes
Show child attributes