Skip to main content
GET
/
status
/
workflow
/
{workflowId}
Workflow status overview
curl --request GET \
  --url https://collectwiseapi.com/status/workflow/{workflowId} \
  --header 'collectwise_key: <api-key>'
import requests

url = "https://collectwiseapi.com/status/workflow/{workflowId}"

headers = {"collectwise_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {collectwise_key: '<api-key>'}};

fetch('https://collectwiseapi.com/status/workflow/{workflowId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://collectwiseapi.com/status/workflow/{workflowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "collectwise_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://collectwiseapi.com/status/workflow/{workflowId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("collectwise_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://collectwiseapi.com/status/workflow/{workflowId}")
  .header("collectwise_key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://collectwiseapi.com/status/workflow/{workflowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["collectwise_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{}
{
  "code": 400,
  "message": "Invalid input: debtorName is required"
}
{
  "code": 400,
  "message": "Invalid input: debtorName is required"
}
{
  "code": 400,
  "message": "Invalid input: debtorName is required"
}
{
  "code": 400,
  "message": "Invalid input: debtorName is required"
}
{
  "code": 400,
  "message": "Invalid input: debtorName is required"
}

Example Response

{
  "workflow": { "id": "197c3300-bcd5-4c0b-a8ad-535b3abbdeb0", "name": "3-day SMS Workflow" },
  "totals": { "enrolled": 205, "paused": 5, "eligibleNow": 0, "queued": 200, "noNextStage": 5 },
  "stages": [ { "stageName": "SMS 2", "count": 200 } ],
  "windowHours": 24,
  "smsSummary": { "Delivered": 200 },
  "recentSms": [
    {
      "id": "msg_...",
      "phone_number": "+15555998608",
      "debtor_id": "9115e0de-01e2-416a-8b0c-4d46d9b6c032",
      "content": "templateId:48 message:Hello {debtorName}...",
      "created_at": "2025-09-08T20:16:01.608Z",
      "status": "Delivered"
    }
  ]
}

Authorizations

collectwise_key
string
header
required

Path Parameters

workflowId
string
required

Unique identifier of the workflow

Query Parameters

hours
integer
default:24

Lookback window in hours. Defaults to 24; clamped to [1, 8760].

Required range: 1 <= x <= 8760
date
string

Specific UTC day in YYYY-MM-DD format; when provided, supersedes the hours window.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Workflow status overview returned

The response is of type object.