Skip to main content
POST
/
status
/
debtors
Per-debtor workflow status and recent SMS
curl --request POST \
  --url https://collectwiseapi.com/status/debtors \
  --header 'Content-Type: application/json' \
  --header 'collectwise_key: <api-key>' \
  --data '
{
  "workflowId": "<string>",
  "debtorIds": [
    "<string>"
  ],
  "hours": 24,
  "limit": 20
}
'
{}

​
Example Response

{
  "windowHours": 24,
  "limit": 20,
  "debtors": [
    {
      "debtorId": "24555f289-899c-4b3b-ba4a-b71a3664c671",
      "workflowId": "111c3300-bcd5-4c0b-a8ad-535b3abbdeb0",
      "paused": false,
      "nextExecutionDate": "2025-09-09T15:17:00.000Z",
      "nextStageId": "5eec7688-6721-4c52-8f8d-4d301d796b3b",
      "nextStageName": "SMS 2",
      "smsCounts": { "Delivered": 1 },
      "recentSms": [
        {
          "id": "msg_...",
          "phone_number": "+15552150663",
          "debtor_id": "24555f289-899c-4b3b-ba4a-b71a3664c671",
          "content": "templateId:48 message:Hello {debtorName}...",
          "created_at": "2025-09-08T20:11:03.676Z",
          "status": "Delivered"
        }
      ]
    }
  ]
}

Authorizations

​
collectwise_key
string
header
required

Body

application/json
​
workflowId
string
required

Workflow identifier

​
debtorIds
string[]
required
Minimum array length: 1
​
hours
integer
default:24
Required range: 1 <= x <= 8760
​
limit
integer
default:20
Required range: 1 <= x <= 200

Response

Per-debtor statuses returned

The response is of type object.