Topolo Docs Topolo Platform
Open workspace

List sequences

Discover sequences for a retained campaign and their current lifecycle states.

Outcome

Discover sequences for a retained campaign and their current lifecycle states.

Before you start

  • Verify the environment, credential, authorized organization and the published action permission workspace:read.
  • Discover an accessible Engage workspace and bind resourceType=workspace and its resourceId separately from action input. Fixture identifiers grant no access.

Discover the target

  • Select the authorized workspace. Optionally discover campaignId through campaigns.list; no sequence id is required. Use status=archived to discover archived sequences.
topolo whoami --json
topolo actions get app_topolo_engage.sequences.list --json
topolo workspaces list topolo-engage --json

Input fields

FieldRequiredMeaning and constraints
campaignIdNoOptional campaign identifier discovered in the same workspace, trimmed non-empty string up to 128 characters.
statusNoOptional exact draft, active or archived state; omit to exclude archived sequences.

Validate, plan and execute

Set ENGAGE_WORKSPACE_ID to the identifier of your selected workspace. Prepare payload.json from the current input schema and discovered identifiers. Use the same payload for validation, planning and execution.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions validate app_topolo_engage.sequences.list --data @payload.json --json
topolo actions plan app_topolo_engage.sequences.list --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

Execute the unchanged validated read in the selected workspace.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.sequences.list --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

For MCP, use topolo_get_action, topolo_validate_action, topolo_plan_action and topolo_call_action. Pass the selected resource context separately; confirm:true is required for mutations.

Worked requests and responses

Captured sequences.list · HTTP 200

Action input

{}

Actual local response

{
  "sequences": [
    {
      "id": "eng_seq_2",
      "campaignId": "eng_cmp_2",
      "name": "Two",
      "status": "draft",
      "createdAt": "2026-10-06T08:30:00.000Z",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    },
    {
      "id": "eng_seq_1",
      "campaignId": "eng_cmp_1",
      "name": "One",
      "status": "draft",
      "createdAt": "2026-10-06T08:30:00.000Z",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    }
  ]
}

Source test: sequence routes > lists, filters, renames and scopes sequences. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured sequences.list · HTTP 200

Action input

{}

Actual local response

{
  "sequences": []
}

Source test: sequence routes > enforces permissions and input schemas. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured sequences.list · HTTP 200

Action input

{
  "campaignId": "eng_cmp_1"
}

Actual local response

{
  "sequences": [
    {
      "id": "eng_seq_1",
      "campaignId": "eng_cmp_1",
      "name": "One",
      "status": "draft",
      "createdAt": "2026-10-06T08:30:00.000Z",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    }
  ]
}

Source test: sequence routes > lists, filters, renames and scopes sequences. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured sequences.list · HTTP 200

Action input

{
  "status": "archived"
}

Actual local response

{
  "sequences": [
    {
      "id": "eng_seq_2",
      "campaignId": "eng_cmp_2",
      "name": "Two",
      "status": "archived",
      "createdAt": "2026-10-06T08:30:00.000Z",
      "updatedAt": "2026-10-06T08:30:00.000Z"
    }
  ]
}

Source test: sequence routes > lists, filters, renames and scopes sequences. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Returns sequences[] ordered by createdAt descending then id descending, with no pagination. Default listing excludes archived sequences; a supplied status selects that exact state. campaignId restricts the retained campaign.
  • This read does not contain step bodies or enroll/send anything. Use sequences.get for version detail.

Verify the result

  • Retain sequences[].id and compare campaignId/status to the requested filter. An empty default list does not prove no archived sequence exists.

Recover

Retry the read in the same verified workspace with the exact discovered identifiers. Use status=archived for discovery when appropriate; do not create a replacement sequence or guess another version after not_found.

Refused responses

No refusal response for this action is included in this fixture set. The recovery guidance below is based on the route’s declared permission and input-validation checks.

Error recovery

  • HTTP 403 permission_denied: Stop and inspect the permission required by this action in the current credential. Do not broaden permissions or switch organization automatically.
  • HTTP 422 invalid_action_input: Correct required fields, enums and nested step bounds against the current input schema, then validate the exact intended payload again.

Evidence and limits

  • contracts/sequences.mjs

  • apps/api/src/sequences/sequences-handlers.ts

  • apps/api/src/sequences/sequences-domain.ts

  • apps/api/src/sequences/sequences-repository.ts

  • apps/api/src/copy-qa/version-steps.ts

  • apps/api/src/copy-qa/copy-qa.ts

  • Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

  • Widget/bootstrap use actual app handler but mocked worker runtime and app identity.

  • No gateway execution, live permissions, external delivery or deployed proof.

The examples are local route captures with synthetic context and simulated providers. They do not prove live authorization, CLI/MCP gateway execution, production state or delivery.