Skip to main content
GET
/
v1
/
links
/
{link_id}
/
parsed-documents
List all parsed documents
curl --request GET \
  --url https://prod.truv.com/v1/links/{link_id}/parsed-documents/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
{
  "count": 42,
  "results": [
    {
      "document_type": "VOLUNTEER_LETTER",
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "document_subtype": "VOL_TRANSCRIPT",
      "file": "https://cdn.truv.com/files_examples/VOLUNTEER_LETTER.pdf",
      "md5sum": "24d7e80942ce4ad58a93f70ce4115f5c"
    }
  ],
  "next": "https://prod.truv.com/v1/links/{link_id}/parsed-documents/?page=2",
  "previous": null
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Path Parameters

​
link_id
string
required

Link ID

Query Parameters

​
document_type
enum<string>

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

Available options:
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
​
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