Skip to content
AcrivaDocs

SearchDocuments

GET
/api/v1/t/{tenant}/search/documents
curl --request GET \
  --url 'https://example.com/api/v1/t/example/search/documents?status=Processing&semantic=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Query Parameters

Section titled “Query Parameters”
q
string
documentTypeId
string format: uuid
fileId
string format: uuid
tagId
Array<string>
status
Allowed values: Processing Active Archived
dateFrom
string format: date
dateTo
string format: date
amountMin
number format: double
amountMax
number format: double
offset
integer format: int32
limit
integer format: int32
semantic
boolean

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
title
required
string
documentTypeId
required
null | string format: uuid
status
required
Allowed values: Processing Active Archived
isConfidential
required
boolean
documentDate
required
null | string format: date
amount
required
null | number format: double
currency
required
null | string
invoiceNumber
required
null | string
vendorName
required
null | string
snippet
required
Array<object>
object
text
required
string
match
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
integer format: int64
facets
required
object
documentTypes
required
Array<object>
object
documentTypeId
required
null | string format: uuid
count
required
integer format: int64
files
required
Array<object>
object
id
required
string format: uuid
count
required
integer format: int64
tags
required
Array<object>
object
id
required
string format: uuid
count
required
integer format: int64
statuses
required
Array<object>
object
status
required
Allowed values: Processing Active Archived
count
required
integer format: int64
years
required
Array<object>
object
year
required
integer format: int32
count
required
integer format: int64
amountBands
required
Array<object>
object
from
required
null | number format: double
to
required
null | number format: double
count
required
integer format: int64
nextOffset
required
null | integer format: int32
mode
required
Allowed values: fts semantic
Example
{
  "items": [
    {
      "status": "Processing"
    }
  ],
  "facets": {
    "statuses": [
      {
        "status": "Processing"
      }
    ]
  },
  "mode": "fts"
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}