documents

2 endpoints at a glance

Method	Path	Summary
GET	/documents	List Documents
GET	/documents/facets	Document Facets

documents

---

List Documents

GET

/documents

One page of visible documents, newest first.

has_more is best-effort: because the ACL pass runs after the query we
report whether the store still had rows left, not an exact remaining count.
A precise total would mean ACL-checking the entire collection on every
request.

Parameters

Header Parameters

authorization

Query Parameters

q

doc_type

entity_type

untyped

Type

boolean

Default

false

page

Type

integer

Default

1

limit

Type

integer

Maximum

200

Minimum

1

Default

50

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/documents

Playground

Headers

authorization

Variables

Key

Value

q

doc_type

entity_type

untyped

page

limit

Samples

---

Document Facets

GET

/documents/facets

Counts for the filter bar: by doc_type, by entity_type, and how many
are still unclassified (the "needs filing" worklist).

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/documents/facets

Playground

Headers

authorization

Samples

---