Topolo Docs Topolo Platform
Open workspace

List journey enrollments

List a journey's enrollments, newest first, optionally by status (active, completed, converted, exited); up to 200. Each enrollment is pinned to a version and shows the node it will run next and when (dueAt).

Outcome

List a journey's enrollments, newest first, optionally by status (active, completed, converted, exited); up to 200. Each enrollment is pinned to a version and shows the node it will run next and when (dueAt).

Before you start

  • Verify identity and pin the intended organization and environment before discovering the action.
  • Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
  • Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.journeys.enrollments.list --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.journeys.list --detail --json
  • id: journeys record id in the selected workspace.

Request

GET /api/journeys/{id}/enrollments

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

FieldRequiredTypeConstraints
idRequiredstringjourneys record id in the selected workspace. {"minLength":1,"maxLength":64}
statusOptionalstring{"enum":["active","completed","converted","exited"]}
limitOptionalinteger{"minimum":1,"maximum":200}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "completed",
        "converted",
        "exited"
      ]
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

  • Reads enrollments without changing state.

Interpret the response

The returned identifier path is $.enrollments[].id for journey_enrollment. Empty lists do not discover a target.

Confirm every enrollment has the requested journeyId.

Exact success schema:

{
  "type": "object",
  "required": [
    "journeyId",
    "enrollments"
  ],
  "properties": {
    "journeyId": {
      "type": "string"
    },
    "enrollments": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "journeyId",
          "version",
          "contactId",
          "status",
          "currentNodeId",
          "dueAt",
          "enrolledAt"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "journeyId": {
            "type": "string"
          },
          "version": {
            "type": "integer"
          },
          "contactId": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "completed",
              "converted",
              "exited"
            ]
          },
          "currentNodeId": {
            "type": "string"
          },
          "stepSeq": {
            "type": "integer"
          },
          "attempts": {
            "type": "integer"
          },
          "dueAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "exitReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "source": {
            "type": "string"
          },
          "enrolledAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "id": "jny_a4e00379d5a046c4ac93d74dcb7a0464"
}

CLI:

topolo actions validate app_topolo_nurture.journeys.enrollments.list --data @payload.json --json
topolo actions plan app_topolo_nurture.journeys.enrollments.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.journeys.enrollments.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.journeys.enrollments.list",
    "input": {
      "id": "jny_a4e00379d5a046c4ac93d74dcb7a0464"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "journeyId": "jny_a4e00379d5a046c4ac93d74dcb7a0464",
  "enrollments": [
    {
      "id": "jen_0bc5042b2a49492594695f352e0f547c",
      "journeyId": "jny_a4e00379d5a046c4ac93d74dcb7a0464",
      "version": 1,
      "contactId": "nct_0c7586f8a0d74fcc8762b748c539c98a",
      "status": "active",
      "currentNodeId": "hello",
      "stepSeq": 0,
      "attempts": 0,
      "dueAt": "2026-10-09T09:00:00.000Z",
      "exitReason": null,
      "source": "event:inactive",
      "enrolledAt": "2026-10-09T09:00:00.000Z",
      "updatedAt": "2026-10-09T09:00:00.000Z"
    }
  ]
}

HTTP 200. Confirm every enrollment has the requested journeyId.

Another supported request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "id": "jny_9ba96e2c4dc24cc0b39eba6529d5456d"
}

CLI:

topolo actions validate app_topolo_nurture.journeys.enrollments.list --data @payload.json --json
topolo actions plan app_topolo_nurture.journeys.enrollments.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.journeys.enrollments.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.journeys.enrollments.list",
    "input": {
      "id": "jny_9ba96e2c4dc24cc0b39eba6529d5456d"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "journeyId": "jny_9ba96e2c4dc24cc0b39eba6529d5456d",
  "enrollments": [
    {
      "id": "jen_e800d67c92c94f748b825763ae0321d8",
      "journeyId": "jny_9ba96e2c4dc24cc0b39eba6529d5456d",
      "version": 1,
      "contactId": "nct_06545a7529664c97abb7e1b1337dcc4e",
      "status": "active",
      "currentNodeId": "hello",
      "stepSeq": 0,
      "attempts": 0,
      "dueAt": "2026-10-01T09:00:00.000Z",
      "exitReason": null,
      "source": "event:subscription_changed",
      "enrolledAt": "2026-10-01T09:00:00.000Z",
      "updatedAt": "2026-10-01T09:00:00.000Z"
    }
  ]
}

HTTP 200. Confirm every enrollment has the requested journeyId.

Refused request · permission_denied

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "id": "jny_2f1edea9fb014621bb1a6dbbd35085ce"
}

CLI:

topolo actions validate app_topolo_nurture.journeys.enrollments.list --data @payload.json --json
topolo actions plan app_topolo_nurture.journeys.enrollments.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:read.",
    "details": {
      "requiredPermission": "workspace:read"
    }
  }
}

HTTP 403. Preserve the refusal details and do not claim success.

Refused request · not_found

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "id": "jny_missing"
}

CLI:

topolo actions validate app_topolo_nurture.journeys.enrollments.list --data @payload.json --json
topolo actions plan app_topolo_nurture.journeys.enrollments.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Journey was not found in this workspace."
  }
}

HTTP 404. Preserve the refusal details and do not claim success.

Verify the result

  • Confirm every enrollment has the requested journeyId.

Errors and recovery

  • organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
  • permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
  • workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
  • invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
  • not_found (HTTP 404): List journeys to find a valid id in this workspace.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

This action does not change service state.

  • Get journey enrollment: Read one enrollment with its step history (each node taken, outcome and time) and the sends it intended: each send node took an eligibility reservation (status intended) or records why it could not (blocked, deferred, failed). Each intended send is delivered through Nexus email.send when the workspace has a verified sender (sending_settings.get), queued in the outbox when no Nexus credential is usable, and only recorded when no sender is configured.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.