--- title: "List a project's sequences" method: GET path: "/v1/projects/{project}/sequences" tags: ["Recovery Sequences"] --- # List a project's sequences `GET /v1/projects/{project}/sequences` ## Request - Base URL: `https://api.subscriby.net` - URL: `https://api.subscriby.net/v1/projects/{project}/sequences` - Auth: HTTP bearer ```bash curl "https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/sequences?active=true&per_page=25" \ -H "Authorization: Bearer sbt_..." ``` Pages the project's sequences, newest first, each with its steps in order and how it has done: every member ever enrolled, the members still receiving steps, the members who received every step, and the members a payment brought back while they were enrolled. `active` keeps the running or the paused ones; `trigger` keeps one trigger; `sort_by` takes `created_at`, `name` or `updated_at`. ## Path parameters - `project` string, uuid, required ## Query parameters - `active` 'true' | 'false' | '1' | '0' - `trigger` 'churned' | 'lead' | 'stalled_checkout' | 'trial_ending': What enrols a member in a sequence. Four moments, each with its own listener or sweep: a membership that ended (the churn listener), a lead that arrived (the member service's event), a checkout that stalled (the hourly ledger sweep) and a trial that will end unpaid (the hourly trial sweep). The column is an `enum()` declared whole, so the three Lead nurture triggers were on it before anything fired them; `isAvailable()` is what the surfaces and the service ask before a sequence may be built on a trigger, and it answers yes for all four since Lead nurture. - `page` integer - `per_page` integer - `sort_by` string - `sort_direction` 'asc' | 'desc' - `limit` integer ## Response `200` The page of sequences, newest first, each with its steps and its counts. - object - `data` SequenceResource[], required: The items on this page. - `id` string, required: The sequence's id. - `project_id` string, required: The project the sequence belongs to. - `name` string, required: A creator-facing label. - `trigger` string, required: What enrols a member: `churned` (their last live membership ended), `lead` (they arrived without buying), `stalled_checkout` (a checkout stayed open past the project's window) or `trial_ending` (a trial without a card is about to end). - `active` boolean, required: Whether the sequence enrols and sends. - `steps` SequenceStepResource[]: The steps in order, present when the relation is loaded. - `id` string, required: The step's id. A step rewritten in place keeps it. - `position` integer, required: The step's place, contiguous from 1. - `delay_days` integer, required: Days after the trigger for the first step, 0 to 180 (`0` goes out on the next hourly run); days after the step before for the rest, 1 to 180. - `body` string, required: The message with its placeholders unfilled: `{name}`, `{project}`, `{coupon}`, `{discount}` and `{link}`. - `coupon` object, nullable: The coupon the step carries, present when the relation is loaded; `null` without one. - `id` string, required: The coupon's id. - `code` string, required: The coupon's code. - `counts` object, required: How the sequence has done, all time. - `enrolled` string, required: Every member ever enrolled. - `open` string, required: Members still receiving steps. - `completed` string, required: Members who received every step. - `won_back` string, required: Members for whom a payment settled while the sequence ran. - `created_at` string, nullable, required: When the sequence was built, ISO 8601. - `updated_at` string, nullable, required: When it last changed, ISO 8601. - `deleted_at` string, nullable, required: When the creator deleted it, ISO 8601; `null` while in use. - `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)