HL HuntHL HuntDocs
Dashboard
Browse documentation

RESOURCES

Cases

A debt to collect. Money values are integer cents serialized as strings — never parse them as floats.

GET/casescollections:read

List cases (cursor pagination).

Response

{
  "object": "list",
  "data": [
    {
      "object": "case",
      "id": "…",
      "status": "active",
      "balance_cents": "8000"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Example

curl https://debt.hlhunt.org/api/v1/cases \
  -H "Authorization: Bearer hlh_live_..."
POST/casescollections:writeIdempotency-Key required

Create a case for a debtor (full intake validation; AI outreach may begin).

Request body

{
  "debtorId": "a1b2…",
  "principalCents": 8000,
  "currency": "USD"
}

Response

{
  "object": "case",
  "id": "c3d4…",
  "debtor_id": "a1b2…",
  "status": "intake",
  "principal_cents": "8000",
  "balance_cents": "8000"
}

Example

curl https://debt.hlhunt.org/api/v1/cases \
  -H "Authorization: Bearer hlh_live_..." \
  -X POST \
  -H "Idempotency-Key: my-unique-key" \
  -H "Content-Type: application/json" \
  -d '{ "debtorId": "a1b2…", "principalCents": 8000, "currency": "USD" }'
GET/cases/{id}collections:read

Retrieve one case.

Response

{
  "object": "case",
  "id": "c3d4…",
  "debtor_id": "a1b2…",
  "status": "active",
  "principal_cents": "8000",
  "balance_cents": "6500"
}

Example

curl https://debt.hlhunt.org/api/v1/cases/ID \
  -H "Authorization: Bearer hlh_live_..."