GET
/
external-api
/
v1
/
debtors
/
{id}
Get Debtor
curl --request GET \
  --url https://getbill.io/external-api/v1/debtors/{id} \
  --header 'Authorization: <authorization>'
{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "def456ghi789",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+33612345678",
      "address": "123 Main Street, 75001 Paris, France",
      "dateOfBirth": "1985-03-15",
      "firstSeenAt": "2024-01-15 10:30:00",
      "lastSeenAt": "2024-01-20 14:22:00",
      "lastUpdatedAt": "2024-01-20 14:22:00",
      "totalDebtAmount": 2500.00,
      "totalPaidAmount": 750.00,
      "averageRepaymentScore": 65,
      "debtsCount": 3
    }
  }
}

​
Overview

This endpoint returns detailed information about a specific debtor, including aggregated statistics about their debts.

​
Authentication

Requires a valid OAuth 2.0 access token with the debtors:read scope.

​
Request

​
Authorization
string
required
Bearer token for authentication

​
Path Parameters

​
id
string
required
The encrypted debtor ID

​
Example Request

curl -X GET "/external-api/v1/debtors/def456ghi789" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

​
Response

​
error
boolean
Always false for successful requests
​
message
string
Success message
​
data
object
Response data wrapper

​
Success Response

{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "def456ghi789",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+33612345678",
      "address": "123 Main Street, 75001 Paris, France",
      "dateOfBirth": "1985-03-15",
      "firstSeenAt": "2024-01-15 10:30:00",
      "lastSeenAt": "2024-01-20 14:22:00",
      "lastUpdatedAt": "2024-01-20 14:22:00",
      "totalDebtAmount": 2500.00,
      "totalPaidAmount": 750.00,
      "averageRepaymentScore": 65,
      "debtsCount": 3
    }
  }
}

​
Error Responses

{
  "error": true,
  "message": "Authentication credentials are missing or invalid",
  "code": 401
}

​
Rate Limiting

This endpoint is subject to rate limiting. See the Rate Limits documentation for details. Rate Limit: 1,000 requests per hour