Skip to main content
GET
List available documents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

company_scope
boolean

Include documents from the company collection if True.

include_details
boolean

Include detail fields (e.g., TLSH signature for duplicate detection). Default: false.

page
integer

A page number within the paginated result set.

private_scope
boolean

Include documents from the user's private collection if True.

tags
string

Comma-separated list of tag IDs to filter by.

workspace_scope
integer

Include documents contained in workspace with ID given.

Response

200 - application/json
object
string
Example:

"list"

count
integer
Example:

123

next
string<uri> | null
Example:

"https://paradigm.lighton.ai/api/v2/files/?page=4"

previous
string<uri> | null
Example:

"https://paradigm.lighton.ai/api/v2/files/?page=2"

data
object[]