Skip to main content
Customer API

Tasks

Base URL
https://customer-api.debitura.com
Authentication
API key in the XApiKey header

List your open tasks

GET/tasks

Returns a paginated, account-wide list of every task (action-item) your account currently has — across ALL cases, not just one. Use GET /cases/{id}/tasks instead to scope this to a single case.

What is a task? A task is something the platform needs YOU to do before a case can proceed — e.g. reply to a chat message, sign a contract, or assign a bank account for payouts. Tasks auto-resolve when the underlying condition clears (for example, once you reply to the case's chat, the ReplyToChat task disappears on its own) — this is a live work queue, not an append-only log. Poll it, don't assume a task you've seen before is still open.

Every task has a solutionUrl — an absolute link, identical to the one used inside the Creditor app itself, that a human can open to resolve the task in one click, no matter the task type.

Some tasks also have an action — a machine-readable hint pointing at the exact existing API call that resolves the task directly, with no human required. Today that's the chat-driven cluster (ReplyToChat, ClientInputRequired, MoreInfoNeeded) — post a message via POST /cases/{caseId}/chats and the task resolves itself once the case leaves its needs-info state. Tasks without an action are action: null — resolve those via solutionUrl.

Some tasks also carry a leadId — the lead the task is decided on. The quote-review tasks both mean a quote is waiting on YOUR decision: IncumbentLegalQuotePending — the partner already on the case has sent a legal-offer quote for you to approve or decline; ReviewQuotes — one or more quotes have arrived on the case's lead and you must choose how to proceed. The two never appear together on the same lead. Both are attached to a case, so they return caseId AND leadId, and their solutionUrl points at the lead rather than the case. The older SelectQuoteWinner task also carries a leadId, but is attached to the lead itself — so it has no caseId and never appears under GET /cases/{id}/tasks.

Filtering:

  • status (default: Open) — Open or Solved
  • type (repeatable, e.g. ?type=ReplyToChat&type=SignContract) — restrict to specific task types

Pagination:

  • Page (default: 1), PageSize (default: 10, max: 100)

Query parameters

  • statusstring
  • typearray of strings
  • Pageinteger
  • PageSizeinteger

Returns

200 Tasks returned

  • pageobjectRequired

    Stable v1 pagination metadata shared by public list responses.

  • tasksarray of objectsnullable

    A creditor-facing action item ("task") — something the platform needs the client to do before a case can proceed (e.g. reply to a chat, sign a contract, assign a bank account).

    Every task carries a SolutionUrl — an absolute link identical to the one used inside the Creditor app — so a human can resolve any task in one click, even task types that are not yet directly API-actionable. Tasks that ARE directly API-actionable additionally carry a non-null Action pointing at the exact API call that resolves them.

Errors

400Invalid status, type, or pagination parameters

See Error handling.

GET/tasks
curl https://customer-api.debitura.com/tasks \
  -H "XApiKey: $DEBITURA_API_KEY"
Response
{
  "page": {
    "totalResults": 42,
    "pageSize": 25,
    "currentPage": 1,
    "responseCount": 42,
    "totalPages": 1
  },
  "tasks": [
    {
      "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
      "type": "string",
      "typeLabel": "string",
      "title": "string",
      "description": "string",
      "status": "string",
      "caseId": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
      "caseReference": "INV-2026-0042",
      "leadId": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
      "deadline": "2026-10-01T14:05:00Z",
      "dateCreated": "2026-10-01T14:05:00Z",
      "dateSolved": "2026-10-01T14:05:00Z",
      "solutionUrl": "https://app.debitura.com/…",
      "action": {
        "method": "string",
        "path": "string"
      }
    }
  ]
}