Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{
"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"
}
}
Retrieve detailed information about a specific followup
followups:read scope.
curl -X GET "/external-api/v1/followups/followup_abc123" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
const followupId = 'followup_abc123';
const response = await fetch(`/external-api/v1/followups/${followupId}`, {
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}
});
const followup = await response.json();
{
"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": true,
"message": "Access denied to this followup",
"code": 403
}
{
"error": true,
"message": "Followup not found or invalid ID",
"code": 404
}