GET
List Followups

Overview

This endpoint returns a paginated list of all followup activities for debts belonging to your company. You can filter by status, type, date range, and other criteria.

Authentication

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

Request

string
required
Bearer token for authentication

Query Parameters

integer
default:"1"
Page number for pagination
integer
default:"20"
Number of items per page (maximum 100)
string
Filter by followup status. Use simple string values: on_hold, scheduled, in_progress, sent, delivered, deal_found, no_answer, deal_not_found, bad_behavior, failed, cancelled
string
Filter by followup type: call, email, sms, whatsapp, voicemail, manual_call, physical, postmail
string
Filter followups from this date (YYYY-MM-DD)
string
Filter followups to this date (YYYY-MM-DD)
string
Filter followups for a specific debt (encrypted ID)

Example Request

Response

boolean
Always false for successful requests
array
Array of followup objects
object
Pagination metadata

Success Response

Error Responses

Rate Limiting

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