List your workflows

GET/v1/workflows

Without status: the organization's published, active workflows of the key's environment, sorted by name, with id, name, environment, minimum_age and steps, for picking a workflow_id. With status=published, draft or all: the full definitions of the key's environment (published includes deactivated ones). Needs the sessions:write or workflows:write scope. A key issued through Connect with secuveri also needs its connection to include the workflows:read or workflows:write setup right, and workflows:write to see drafts; otherwise it gets 403. At most 120 calls per minute per organization.

Send your API key in the x-api-key header.

Query parameters

  • statusstring

    Omit for the published, active workflows (the short form). published, draft or all return full definitions.

    One ofpublisheddraftall

Responses

  • 200The workflows: the short form without status, full definitions (Workflow) with it.
    • workflowsarray of object
      Show 5 child properties
      • idstringuuid
      • namestring
      • environmentstring

        One ofsandboxproduction

      • minimum_ageinteger | null
      • stepsarray of string
  • 400status is not published, draft or all.
  • 401Missing, unknown or expired API key.
  • 403The key lacks the scope, its IP allowlist refuses the caller, or it was issued through Connect with secuveri without the setup right.
curl https://api-verify.secuveri.com/v1/workflows \
  -H "x-api-key: $SECUVERI_API_KEY"
Response · 200
{
  "workflows": [
    {
      "id": "0b8f4f5e-3c2a-4d1b-9e7f-6a5c4b3d2e1f",
      "name": "Jane Doe",
      "environment": "sandbox",
      "minimum_age": 1,
      "steps": [
        "string"
      ]
    }
  ]
}