Company API
Creditors API
Debtors API
Debts API
Followups API
Todos API
Get Followup
Copy
curl --request GET \
--url https://getbill.io/external-api/v1/followups/{id} \
--header 'Authorization: <authorization>'Copy
{
"error": false,
"message": "Success",
"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": "Successfully contacted debtor, agreed to payment plan",
"notes": "Customer was cooperative and agreed to pay €500 monthly starting February 1st. Will send payment schedule by email.",
"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"
}
}
Followups API
Get Followup
Retrieve detailed information about a specific followup
GET
/
external-api
/
v1
/
followups
/
{id}
Get Followup
Copy
curl --request GET \
--url https://getbill.io/external-api/v1/followups/{id} \
--header 'Authorization: <authorization>'Copy
{
"error": false,
"message": "Success",
"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": "Successfully contacted debtor, agreed to payment plan",
"notes": "Customer was cooperative and agreed to pay €500 monthly starting February 1st. Will send payment schedule by email.",
"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"
}
}
Overview
This endpoint returns comprehensive information about a single followup activity, including all details about the communication attempt, results, and related metadata.Authentication
Requires a valid OAuth 2.0 access token with thefollowups:read scope.
Request
Bearer token for authentication
The encrypted ID of the followup to retrieve
Example Request
Copy
curl -X GET "/external-api/v1/followups/followup_abc123" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Always
false for successful requestsSuccess message
Complete followup information
Show followup object
Show followup object
Encrypted followup identifier
Encrypted debt identifier this followup belongs to
Current status. See Enums Reference for all available values (on_hold, scheduled, in_progress, sent, delivered, read, deal_found, no_answer, deal_not_found, bad_behavior, failed, cancelled)
Type of followup:
call, email, sms, whatsapp, voicemail, manual_call, physical, postmailWhen the followup was executed (ISO 8601 format)
When the followup was scheduled (ISO 8601 format)
Brief summary of the followup results
Detailed notes about the followup
External call ID from the provider
Phone number used for the call
Pre-signed URL to the call recording (expires after 1 hour)
Pre-signed URL to any associated PDF document (expires after 1 hour)
Duration in milliseconds (for calls)
Reason for call disconnection
Call direction (inbound/outbound)
Whether this is a retry attempt
Processing timestamp (ISO 8601 format)
Whether this followup directly triggered a successful payment.
true if the payment link sent via this followup resulted in a paid transaction.Whether the email was opened (for email followups)
Number of times the email was opened
Timestamp of first email open (ISO 8601 format)
Whether a link in the email was clicked
Number of times links in the email were clicked
When the pre-signed media URLs expire (ISO 8601 format). Only present if
audio_url or pdf_url are provided.Success Response
Copy
{
"error": false,
"message": "Success",
"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": "Successfully contacted debtor, agreed to payment plan",
"notes": "Customer was cooperative and agreed to pay €500 monthly starting February 1st. Will send payment schedule by email.",
"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"
}
}
Error Responses
Copy
{
"error": true,
"message": "Access denied to this followup",
"code": 403
}
⌘I