API Reference
Get Documents
Query Parameters
offset?Offset
Number of items to skip
Default
0
Range
0 <= value
limit?Limit
Number of items to return
Default
50
Range
1 <= value <= 1000
Header Parameters
x-api-key?X-Api-Key
API key optional
Response Body
curl -X GET "https://loading/v0/documents?offset=0&limit=50" \
-H "x-api-key: string"
{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
"s3_key": "string",
"file_size": 0,
"mime_type": "string",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_organization_id": "f4a18a38-dd66-4b07-bb7e-c9352ded3c33",
"summary": "string",
"status": "queued",
"document_type": "affidavit",
"flagged_by_user": true,
"user_notes": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total": 0,
"offset": 0,
"limit": 0,
"has_next": true,
"has_previous": true
}
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}