The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

400validation_error

401unauthorized

403forbidden

404not_found

429rate_limit_exceeded

500internal_error

Request

curl -X GET "https://<your-host>/api/v1/cases/<id>/documents?page=1&per_page=25" \
  -H "Authorization: Bearer hlh_test_YOUR_API_KEY"

Response200application/json

{
  "data": [
    {
      "id": string,
      "case_id": string | null,
      "name": string,
      "file_name": string,
      "file_type": string,
      "file_size": string,
      "category": string,
      "status": string,
      "applicant": string | null,
      "version": number,
      "uploaded_by": string,
      "uploaded_at": string | null,
      "reviewed_by": string | null,
      "reviewed_at": string | null,
      "rejection_reason": string | null
    }
  ],
  "pagination": {
    "page": number,
    "per_page": number,
    "total": number,
    "total_pages": number
  }
}

Shown as types, not sample values. A field typed number | null can be null; the response fields table gives the reason.

Browse the API30

cases

get

/api/v1/cases/{id}/documents

The files attached to one case, paginated.

Scope: documents:read
Rate limit: 200 requests / min
Idempotency: read-only

Authentication

Send your key as Authorization: Bearer …. It must carry the scope documents:read; a key without it receives 403 forbidden.

Path parameters

idstringrequired

Query parameters

pageintegerdefault 1min 1

per_pageintegerdefault 25min 1max 100

Request body

This operation takes no request body.

Response

200application/json

dataSerializedDocument[]required

paginationobjectrequired

pagenumberrequired

per_pagenumberrequired

totalnumberrequired

total_pagesnumberrequired

Errors