---
title: "List a sequence's enrolments"
method: GET
path: "/v1/projects/{project}/sequences/{sequence}/enrollments"
tags: ["Recovery Sequences"]
---

# List a sequence's enrolments

`GET /v1/projects/{project}/sequences/{sequence}/enrollments`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/sequences/{sequence}/enrollments`
- Auth: HTTP bearer

```bash
curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/sequences/9d2f4b6a-1c3e-4f58-8a7b-6e5d4c3b2a19/enrollments?exit_reason=reactivated" \
  -H "Authorization: Bearer sbt_..."
```

Every passage a member made through the sequence, the newest first: when they entered, the step due next and when, and how the passage ended if it has. `state` is `open`, `completed` or `exited`, and an exited passage says why: `reactivated` (the member paid again, a win), `opted_out` (the platform could not reach them), `disabled` or `deleted`. `exit_reason` keeps one way out; `sort_by` takes `enrolled_at`, `next_due_at`, `completed_at` or `exited_at`.

## Path parameters

- `project` string, uuid, required
- `sequence` string, uuid, required

## Query parameters

- `exit_reason` 'completed' | 'reactivated' | 'opted_out' | 'disabled' | 'deleted': Why a member's enrolment in a sequence ended. Completed means every step went out; reactivated means a payment settled for the member and the sequence worked, so the steps that went out are converted; the other three stop the steps without a conversion: the member opted out of announcements, the creator switched the sequence off, or deleted it.
- `page` integer
- `per_page` integer
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `limit` integer

## Response `200`

The page of passages, the newest first, each with its member.

- object
  - `data` SequenceEnrollmentResource[], required: The items on this page.
    - `id` string, required: The passage's id, the `enrollment_id` of the sequence events.
    - `sequence_id` string, required: The sequence.
    - `project_id` string, required: The project.
    - `member` object, nullable: The member, present when the relation is loaded.
      - `id` string, required: The member's project-scoped id.
      - `name` string, required: The member's display name.
    - `subscription_id` string, nullable, required: The membership whose end enrolled the member, or `null`.
    - `state` 'completed' | 'open' | 'exited', required: `open` (steps still to come), `completed` (every step received) or `exited` (ended before the last step; see `exit_reason`).
    - `enrolled_at` string, required: When the member entered, ISO 8601.
    - `next_position` integer, required: The step due next while open.
    - `next_due_at` string, nullable, required: When that step falls due, ISO 8601; `null` once the passage ended.
    - `completed_at` string, nullable, required: When the last step went out, ISO 8601; `null` otherwise.
    - `exited_at` string, nullable, required: When the passage ended early, ISO 8601; `null` otherwise.
    - `exit_reason` string, nullable, required: Why it ended early: `reactivated` (a charge settled for the member: a member won back on a churn passage, a conversion on a lead, checkout or trial one), `opted_out` (the member could not be reached, or pressed Stop), `disabled` (the sequence was switched off) or `deleted`; `null` otherwise.
  - `links` object, required: Links to the first, last, previous and next pages.
    - `first` string, nullable, required: The first page's URL.
    - `last` string, nullable, required: The last page's URL.
    - `prev` string, nullable, required: The previous page's URL; null on the first page.
    - `next` string, nullable, required: The next page's URL; null on the last page.
  - `meta` object, required: The paging counters for this page.
    - `current_page` integer, required: The page returned, 1-indexed.
    - `from` integer, nullable, required: The 1-indexed position of this page's first item across every page; null when the page is empty.
    - `last_page` integer, required: How many pages there are.
    - `links` object[], required: Generated paginator links.
      - `url` string, nullable, required: The page's URL; null for the ellipsis and the disabled arrows.
      - `label` string, required: The link's label: a page number, the previous or next arrow, or an ellipsis.
      - `active` boolean, required: Whether this link is the current page.
    - `path` string, nullable, required: Base path for paginator generated URLs.
    - `per_page` integer, required: Number of items shown per page.
    - `to` integer, nullable, required: Number of the last item in the slice.
    - `total` integer, required: Total number of items being paginated.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)