Browse the API30

applicants

get

/api/v1/applicants

The organization's applicant directory, paginated.

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

Authentication

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

Query parameters

pageintegerdefault 1min 1

per_pageintegerdefault 25min 1max 100

searchstring

sortstring (enum)last_activitynamedate_added

statusstring (enum)activeinactive

typestring (enum)individualbusiness

Request body

This operation takes no request body.

Response

200application/json

dataSerializedApplicant[]required

paginationobjectrequired

pagenumberrequired

per_pagenumberrequired

totalnumberrequired

total_pagesnumberrequired

Errors

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

429rate_limit_exceeded

500internal_error

Request

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

Response200application/json

{
  "data": [
    {
      "id": string,
      "name": string,
      "type": string,
      "email": string,
      "phone": string | null,
      "credit_score": number | null,
      "total_applications": number,
      "active_loans": number,
      "total_borrowed": number,
      "status": string,
      "last_activity": string | null,
      "date_added": 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.