Retrieve a portal task

GET/v1/portal-tasks/{id}

Fetch a portal task, its pending action and its result.

Used in Payer portals1 use case

Call this with AIA brief with this endpoint's request, response and auth, ready for a typed client in your language.

Path parameters

idstringrequired
The portal task id.

Try itEdit the fields and copy the request. Nothing is sent from this page.

API keykept in this tab; masked on screen, copied in full

idpath, stringrequired

curl -X GET https://api.daybookhealthcare.com/v1/portal-tasks/ptask_01JBXA2W8K3N \
  -H "Authorization: Bearer $DAYBOOK_API_KEY"

Response

idstring
Unique id, prefixed ptask_.
objectstring
Always portal_task.
statusstring
queued, running, approval_required, completed, failed or canceled.
payerstring
Daybook payer id.
portalstring
The portal used, such as availity or the payer's own site.
taskstring
The task you asked for.
pending_actionobject
What Daybook is about to change in the portal. Present while approval_required.
Properties
- summarystring
  The change, in plain words.
- screenshot_urlstring
  Signed link to the screen as it will be submitted.
resultobject
What Daybook read back. Shape depends on task. null until completed.
evidenceobject[]
Signed links to the pages captured along the way.
metadataobject
Your keys, echoed back.
created_atstring
RFC 3339 timestamp.

curl -X GET https://api.daybookhealthcare.com/v1/portal-tasks/ptask_01JBXA2W8K3N \
  -H "Authorization: Bearer $DAYBOOK_API_KEY"

Response 200

{
  "id": "ptask_01JBXA2W8K3N",
  "object": "portal_task",
  "status": "completed",
  "payer": "keystone",
  "portal": "availity",
  "task": "remit_lookup",
  "pending_action": null,
  "result": {
    "check_or_eft_number": "EFT00048213",
    "payment_date": "2026-10-21",
    "payment_amount_cents": 31200,
    "era_url": "https://files.daybookhealthcare.com/r/ptask_01JBXA2W8K3N/835?sig=..."
  },
  "evidence": [
    {
      "label": "Remittance viewer",
      "url": "https://files.daybookhealthcare.com/e/ptask_01JBXA2W8K3N/1?sig=..."
    }
  ],
  "metadata": {},
  "created_at": "2026-10-29T15:10:40Z"
}