Skip to content
AcrivaDocs

ListDocuments

GET
/api/v1/t/{tenant}/documents
curl --request GET \
  --url 'https://example.com/api/v1/t/example/documents?status=Processing' \
  --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”
documentTypeId
string format: uuid
fileId
string format: uuid
tagId
Array<string>
status
Allowed values: Processing Active Archived Deleted Purging
q
string
savedViewId
string format: uuid
documentDateFrom
string format: date
documentDateTo
string format: date
amountMin
number format: double
amountMax
number format: double
createdBy
string format: uuid
retention
integer
importId
string format: uuid
sort
integer
cursor
string
limit
integer format: int32
includeSplit
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 Deleted Purging
isConfidential
required
boolean
currentVersion
required
integer format: int32
contentType
required
null | string
size
required
null | integer format: int64
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
createdBy
required
string format: uuid
createdByName
required
null | string
files
required
Array<object>
object
id
required
string format: uuid
name
required
string
documentDate
required
null | string format: date
amount
required
null | number format: double
currency
required
null | string
retentionUntil
required
null | string format: date
legalHold
required
boolean
inSignature
required
boolean
nextCursor
required
null | string
isSearchTruncated
required
boolean
total
required
integer format: int32
isTotalCapped
required
boolean
Example
{
  "items": [
    {
      "status": "Processing"
    }
  ]
}

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"
}

404

Section titled “404”

Not Found

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"
}