{
"filters": {
"customer_external_id": "string",
"display_name": "string",
"file_name": "string",
"file_types": [
"string"
],
"max_created_at": "integer",
"min_created_at": "integer",
"tags": [
"string"
]
},
"limit": "integer",
"offset": "integer"
}
const response = await fetch(
"POST /api/v1/customer_documents/search",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"filters": {
"customer_external_id": "string",
"display_name": "string",
"file_name": "string",
"file_types": [
"string"
],
"max_created_at": "integer",
"min_created_at": "integer",
"tags": [
"string"
]
},
"limit": "integer",
"offset": "integer"
})
}
);
{
"documents": [
{
"created_at": "integer",
"customer_external_id": "string",
"display_name": "string",
"file_mime": "string",
"file_name": "string",
"file_size": "integer",
"file_source": "string",
"file_type": "string",
"file_url": "string",
"id": "string",
"last_revision_agent_id": "integer",
"last_revision_created_at": "integer",
"last_revision_id": "string",
"origin": {
"type": {},
"value": "string"
},
"tags": [
"string"
]
}
],
"total": "integer"
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Customer Document
Search documents
Searches for documents that match the input filters.
POST
/
api
/
v1
/
customer_documents
/
search
{
"filters": {
"customer_external_id": "string",
"display_name": "string",
"file_name": "string",
"file_types": [
"string"
],
"max_created_at": "integer",
"min_created_at": "integer",
"tags": [
"string"
]
},
"limit": "integer",
"offset": "integer"
}
const response = await fetch(
"POST /api/v1/customer_documents/search",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"filters": {
"customer_external_id": "string",
"display_name": "string",
"file_name": "string",
"file_types": [
"string"
],
"max_created_at": "integer",
"min_created_at": "integer",
"tags": [
"string"
]
},
"limit": "integer",
"offset": "integer"
})
}
);
{
"documents": [
{
"created_at": "integer",
"customer_external_id": "string",
"display_name": "string",
"file_mime": "string",
"file_name": "string",
"file_size": "integer",
"file_source": "string",
"file_type": "string",
"file_url": "string",
"id": "string",
"last_revision_agent_id": "integer",
"last_revision_created_at": "integer",
"last_revision_id": "string",
"origin": {
"type": {},
"value": "string"
},
"tags": [
"string"
]
}
],
"total": "integer"
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Body parameters
integer
integer
Response body
- 200
- default
CustomerDocument[]
integer
{
"filters": {
"customer_external_id": "string",
"display_name": "string",
"file_name": "string",
"file_types": [
"string"
],
"max_created_at": "integer",
"min_created_at": "integer",
"tags": [
"string"
]
},
"limit": "integer",
"offset": "integer"
}
const response = await fetch(
"POST /api/v1/customer_documents/search",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"filters": {
"customer_external_id": "string",
"display_name": "string",
"file_name": "string",
"file_types": [
"string"
],
"max_created_at": "integer",
"min_created_at": "integer",
"tags": [
"string"
]
},
"limit": "integer",
"offset": "integer"
})
}
);
{
"documents": [
{
"created_at": "integer",
"customer_external_id": "string",
"display_name": "string",
"file_mime": "string",
"file_name": "string",
"file_size": "integer",
"file_source": "string",
"file_type": "string",
"file_url": "string",
"id": "string",
"last_revision_agent_id": "integer",
"last_revision_created_at": "integer",
"last_revision_id": "string",
"origin": {
"type": {},
"value": "string"
},
"tags": [
"string"
]
}
],
"total": "integer"
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
⌘I