GET
/
external-api
/
v1
/
followups
/
debt
/
{debtId}
Get Followups by Debt
curl --request GET \
  --url https://getbill.io/external-api/v1/followups/debt/{debtId} \
  --header 'Authorization: <authorization>'
{
  "error": false,
  "data": [
    {
      "id": "abc123def456",
      "debt_id": "xyz789ghi012",
      "status": "deal_found",
      "type": "call",
      "call_date": "2024-01-22T10:30:00+00:00",
      "scheduled_at": "2024-01-22T10:00:00+00:00",
      "summary": "Initial contact attempt - successful",
      "notes": "Customer answered, discussed payment options",
      "call_id": "call_789456",
      "audio_url": "https://s3.amazonaws.com/bucket/recordings/call_789456.mp3?X-Amz-Signature=...",
      "pdf_url": null,
      "duration_ms": 180000,
      "disconnection_reason": "completed_successfully",
      "direction": "outbound",
      "phone_number_used": "+33800123456",
      "is_retry": false,
      "processed_at": "2024-01-22T10:35:00+00:00",
      "triggered_payment": true,
      "email_opened": false,
      "email_open_count": 0,
      "email_first_opened_at": null,
      "email_clicked": false,
      "email_click_count": 0,
      "media_urls_expire_at": "2024-01-22T11:35:00+00:00"
    },
    {
      "id": "def456ghi789",
      "debt_id": "xyz789ghi012",
      "status": "delivered",
      "type": "email",
      "call_date": "2024-01-20T14:15:00+00:00",
      "scheduled_at": "2024-01-20T14:00:00+00:00",
      "summary": "Payment reminder sent",
      "notes": "Automated reminder email with payment instructions",
      "call_id": null,
      "audio_url": null,
      "pdf_url": null,
      "duration_ms": null,
      "disconnection_reason": null,
      "direction": null,
      "phone_number_used": null,
      "is_retry": false,
      "processed_at": "2024-01-20T14:15:00+00:00",
      "triggered_payment": false,
      "email_opened": true,
      "email_open_count": 3,
      "email_first_opened_at": "2024-01-20T15:30:00+00:00",
      "email_clicked": true,
      "email_click_count": 1
    }
  ],
  "pagination": {
    "total": 5,
    "page": 1,
    "limit": 50,
    "pages": 1
  }
}

​
Overview

This endpoint returns a paginated list of all followup activities associated with a specific debt. This is useful for getting the complete communication history for a particular debtor.

​
Authentication

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

​
Request

​
Authorization
string
required
Bearer token for authentication
​
debtId
string
required
The encrypted ID of the debt to get followups for

​
Query Parameters

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

​
Example Request

curl -X GET "/external-api/v1/followups/debt/xyz789ghi012?limit=50" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Response

​
error
boolean
Always false for successful requests
​
data
array
Array of followup objects for the specified debt
​
pagination
object
Pagination metadata

​
Success Response

{
  "error": false,
  "data": [
    {
      "id": "abc123def456",
      "debt_id": "xyz789ghi012",
      "status": "deal_found",
      "type": "call",
      "call_date": "2024-01-22T10:30:00+00:00",
      "scheduled_at": "2024-01-22T10:00:00+00:00",
      "summary": "Initial contact attempt - successful",
      "notes": "Customer answered, discussed payment options",
      "call_id": "call_789456",
      "audio_url": "https://s3.amazonaws.com/bucket/recordings/call_789456.mp3?X-Amz-Signature=...",
      "pdf_url": null,
      "duration_ms": 180000,
      "disconnection_reason": "completed_successfully",
      "direction": "outbound",
      "phone_number_used": "+33800123456",
      "is_retry": false,
      "processed_at": "2024-01-22T10:35:00+00:00",
      "triggered_payment": true,
      "email_opened": false,
      "email_open_count": 0,
      "email_first_opened_at": null,
      "email_clicked": false,
      "email_click_count": 0,
      "media_urls_expire_at": "2024-01-22T11:35:00+00:00"
    },
    {
      "id": "def456ghi789",
      "debt_id": "xyz789ghi012",
      "status": "delivered",
      "type": "email",
      "call_date": "2024-01-20T14:15:00+00:00",
      "scheduled_at": "2024-01-20T14:00:00+00:00",
      "summary": "Payment reminder sent",
      "notes": "Automated reminder email with payment instructions",
      "call_id": null,
      "audio_url": null,
      "pdf_url": null,
      "duration_ms": null,
      "disconnection_reason": null,
      "direction": null,
      "phone_number_used": null,
      "is_retry": false,
      "processed_at": "2024-01-20T14:15:00+00:00",
      "triggered_payment": false,
      "email_opened": true,
      "email_open_count": 3,
      "email_first_opened_at": "2024-01-20T15:30:00+00:00",
      "email_clicked": true,
      "email_click_count": 1
    }
  ],
  "pagination": {
    "total": 5,
    "page": 1,
    "limit": 50,
    "pages": 1
  }
}

​
Use Cases

This endpoint is particularly useful for:
  • Complete Communication History: Get all interactions with a specific debtor
  • Timeline Analysis: Understand the progression of collection efforts
  • Performance Tracking: Analyze success rates for different followup types
  • Compliance: Maintain complete records of collection activities

​
Error Responses

{
  "error": true,
  "message": "Access denied to this debt",
  "code": 403
}