GET
/
external-api
/
v1
/
debtors
List Debtors
curl --request GET \
  --url https://getbill.io/external-api/v1/debtors \
  --header 'Authorization: <authorization>'
{
  "error": false,
  "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"
    },
    {
      "id": "jkl012mno345",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "phone": "+33698765432",
      "address": "456 Oak Avenue, 69001 Lyon, France",
      "dateOfBirth": "1990-07-22",
      "firstSeenAt": "2024-01-10 09:15:00",
      "lastSeenAt": "2024-01-18 11:45:00",
      "lastUpdatedAt": "2024-01-18 11:45:00"
    }
  ],
  "pagination": {
    "total": 512,
    "page": 1,
    "limit": 50,
    "pages": 11
  }
}

​
Overview

This endpoint returns a paginated list of debtors who have debts belonging to your company. Debtors are individuals or entities that owe money.

​
Authentication

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

​
Request

​
Authorization
string
required
Bearer token for authentication

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination (starts at 1)
​
limit
integer
default:"20"
Number of items per page (maximum 100)

​
Example Request

curl -X GET "/external-api/v1/debtors?page=1&limit=50" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

​
Response

​
error
boolean
Always false for successful requests
​
data
array
Array of debtor objects
​
pagination
object
Pagination metadata

​
Success Response

{
  "error": false,
  "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"
    },
    {
      "id": "jkl012mno345",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "phone": "+33698765432",
      "address": "456 Oak Avenue, 69001 Lyon, France",
      "dateOfBirth": "1990-07-22",
      "firstSeenAt": "2024-01-10 09:15:00",
      "lastSeenAt": "2024-01-18 11:45:00",
      "lastUpdatedAt": "2024-01-18 11:45:00"
    }
  ],
  "pagination": {
    "total": 512,
    "page": 1,
    "limit": 50,
    "pages": 11
  }
}

​
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