---
title: "Get a sequence"
method: GET
path: "/v1/projects/{project}/sequences/{sequence}"
tags: ["Recovery Sequences"]
---

# Get a sequence

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

## Request

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

One sequence with its steps and its counts. A sequence of another project, or one the creator deleted, is `404 RESOURCE_NOT_FOUND`.

## Path parameters

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

## Response `200`

The sequence with its steps and its counts.

- object
  - `data` SequenceResource, required: A sequence: the ordered messages a member receives on the days the creator chose after one of four moments (they left, they arrived as a lead, their checkout stalled, their trial is about to end), each with the way to the plan and, optionally, a coupon; with how many members it enrolled, how many are still receiving it and how many paid while it ran.
    - `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.

## 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.
- `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)