Version
READ

list_sequence_enrollments

List the passages members made through one win-back sequence — when they entered, the step due next, and how the passage ended if it has. Read-only. Paginated, narrowed by the way out.

Read the members behind a sequence's counts. Each passage says when the member entered, the step due next and when while it is open, and how it ended: state is open, completed (every step received) or exited, and an exited passage says why in exit_reason. Narrow by exit_reason to list the members a sequence won back, or the ones the platform could not reach.

Read-only. Never mutates anything.

One passage per departure

A member enrols once each time their last live membership ends, never while they hold one, so a member who left twice has two passages. reactivated means a charge settled for them while they were enrolled, which the figures count as won back.

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

Arguments

project_id*string

UUID of the project the sequence belongs to.

sequence_id*string

UUID of the sequence whose passages to list.

exit_reasonstringoptional

Optional: keep the passages that ended this way: "reactivated", "opted_out", "disabled" or "deleted". Omit for every passage, open ones included.

limitintegeroptional

Maximum passages to return per page (1..100).

min1max100
pageintegeroptional

1-indexed page number.

min1

What it returns

{  "data": [    {      "id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",      "sequence_id": "9d2f4b6a-1c3e-4f58-8a7b-6e5d4c3b2a19",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "member": { "id": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d", "name": "Ada Lovelace" },      "subscription_id": "2e4f6a8c-1b3d-4e5f-8a9b-0c1d2e3f4a5b",      "state": "exited",      "enrolled_at": "2026-10-01T09:00:00+00:00",      "next_position": 2,      "next_due_at": null,      "completed_at": null,      "exited_at": "2026-10-05T14:30:00+00:00",      "exit_reason": "reactivated"    }  ],  "meta": { "page": 1, "limit": 25, "total": 1, "has_more": false }}

exit_reason is reactivated (the member paid again), opted_out (the platform could not reach them), disabled (the sequence was switched off) or deleted; null while the passage is open or once it completed.

How it fails

VALIDATION_FAILED

an exit_reason that is not one of the values, or limit outside 1..100.

RESOURCE_NOT_FOUND

unknown project_id or sequence_id, a sequence of another project, or one the creator deleted.

AUTHENTICATION_REQUIRED

no authenticated user on the request.

TOKEN_MISSING_ABILITY

token lacks project-sequence:view-any.

How is this guide?

Last updated on