COcollectwise

List debtors

Changed on

Returns all debtors from the system that the user has access to

get/debtor

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/debtor
  • Auth
    API key in header collectwise_key

Query parameters

limitinteger

The maximum number of results to return

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Response

A list of debtors

debtorIdstring required

Unique identifier of the debtor

debtorNamestring required

Full name of the debtor

totalUnpaidDebtnumber float required

Total amount of unpaid debt

delinquencyDatestring date required

Date when the debt became delinquent

phoneNumberstring

Contact phone number of the debtor

emailstring email

Email address of the debtor

callbackNumberstring

Callback phone number

productOrServicestring

Name of the product or service delivered to the debtor

creditorNamestring required

Name of the creditor

creditorEmailstring email

Creditor email if provided

lastUpdatedstring date-time required

Timestamp of the last update to this record

accountNumberstring

Account number associated with the debt

addressstring

Street address of the debtor

citystring

City of the debtor

statestring

State of the debtor

zipCodestring

ZIP code of the debtor

countystring

County of the debtor

ssnstring

Social Security Number of the debtor

lastPayDatestring date

Date of the last payment made by the debtor

chargeOffDatestring date

Date when the debt was charged off, if applicable

interestDuenumber float

Amount of interest due on the debt

principalDuenumber float

Amount of principal due on the debt

otherFeesnumber float

Other fees associated with the debt

amountPaidnumber float

Total amount paid by the debtor so far

paymentLinkstring nullable

Payment link associated with the debtor

customWorkflowIDstring

Custom workflow identifier for the debtor

customizationstring

Custom instructions for AI collection workflow (e.g., tone, channel preferences, frequency). If not provided, the system will generate an optimal collection flow.

Changes