Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Full-text search on document title, uploader username, and uploader email.

ordering
string

Sort field: created_at, title, user__username, fleet__title, or tags. Prefix with - for descending order.

status
enum<string>

Filter by processing status. Repeatable to include multiple statuses.

Available options:
Processing,
Uploaded,
Processed
approved
boolean

Filter by approval flag.

processed
boolean

Filter by processed flag.

sent
boolean

Filter by sent flag.

archived
boolean

Filter by archive flag.

title__icontains
string

Case-insensitive substring match on title. istartswith, iendswith, and exact lookups are also supported.

user__username__icontains
string

Case-insensitive substring match on uploader username.

user__email__icontains
string

Case-insensitive substring match on uploader email.

fleet__title__icontains
string

Case-insensitive substring match on fleet title.

tags__icontains
string

Filter by tag name (case-insensitive substring match).

created_at__gte
string<date>

Return documents created on or after this date (YYYY-MM-DD).

created_at__lte
string<date>

Return documents created on or before this date (YYYY-MM-DD).

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"