Skip to main content
GET
List all parsed documents

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

Link ID

Query Parameters

document_type
enum<string>

Filter by document type. Currently only 'VOLUNTEER_LETTER' is supported.

Available options:
VOLUNTEER_LETTER
Example:

"VOLUNTEER_LETTER"

document_subtype
enum<string>

Filter by document subtype. For volunteer letters use VOL_TRANSCRIPT or VOL_HOURS_LOG.

Available options:
VOL_TRANSCRIPT,
VOL_HOURS_LOG
Example:

"VOL_TRANSCRIPT"

ordering
enum<string>
default:-created_at

Order results by field. Prefix with '-' for descending order.

Available options:
created_at,
-created_at
page
integer
default:1

Page number for pagination

Required range: x >= 1
page_size
integer
default:10

Number of results per page

Required range: 1 <= x <= 50

Response

count
integer
required

Total number of parsed documents

Example:

42

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

URL to next page

Example:

"https://prod.truv.com/v1/links/{link_id}/parsed-documents/?page=2"

previous
string<uri> | null

URL to previous page

Example:

null