Get a workflow

gethttps://api.expiryedge.com/v1/getWorkflow
bearer token (Firebase ID token or session JWT); any role60/min
Anfrage
curl 'https://api.expiryedge.com/v1/getWorkflow?id=wf_3Kd9Tx' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "workflow": {
    "id": "wf_3Kd9Tx",
    "title": "Annual license renewal",
    "description": "Steps to renew a state dental license for Northwind Dental.",
    "owner_id": "u_71bXq",
    "organization_id": "org_northwind",
    "team_id": null,
    "workflow_type_id": "wtype_R4c2",
    "status": "active",
    "progress": 50,
    "tags": [
      "licensing"
    ],
    "due_date": "2026-10-15T00:00:00.000Z",
    "created_at": "2026-09-27T14:05:00.000Z",
    "updated_at": "2026-09-27T14:05:00.000Z"
  },
  "sections": [
    {
      "id": "sec_5Hn2",
      "workflow_id": "wf_3Kd9Tx",
      "title": "Preparation",
      "description": "",
      "order": 0,
      "created_at": "2026-09-27T14:05:00.000Z",
      "steps": [
        {
          "id": "stp_9Qm1",
          "section_id": "sec_5Hn2",
          "workflow_id": "wf_3Kd9Tx",
          "title": "Collect CE certificates",
          "description": "Gather continuing education certificates from each dentist.",
          "assignees": [
            "u_71bXq"
          ],
          "status": "todo",
          "priority": "high",
          "start_date": null,
          "due_date": null,
          "due_offset_days": 7,
          "completed_at": null,
          "order": 0,
          "dependencies": [],
          "time_estimate": 0,
          "time_spent": 0,
          "tags": [],
          "linked_expiry_id": null,
          "created_at": "2026-09-27T14:05:00.000Z"
        }
      ]
    }
  ]
}

Returns the workflow and its sections (sorted by order), each with its steps.

Query-Parameter

  • idstringerforderlich
    Workflow id.

Rückgabe

200
The workflow and its sections.
  • workflowobjecterforderlich
    A workflow template (checklist) that runs are started from.
  • sectionsarray of objectserforderlich

Fehler

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.