Recovery Sequences

List a project's sequences

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.

get/v1/projects/{project}/sequences

Request

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Query parameters

active'true' | 'false' | '1' | '0'

Keep only running sequences (true) or only paused ones (false). Omit for both.

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.

Keep only the sequences on one trigger: churned, lead, stalled_checkout or trial_ending.

pageinteger

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

per_pageinteger

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

sort_bystring

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

limitinteger

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Response

The page of sequences, newest first, each with its steps and its counts.

Example response

{
  "data": [
    {
      "id": "9d2f4b6a-1c3e-4f58-8a7b-6e5d4c3b2a19",
      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
      "name": "Win-back after churn",
      "trigger": "churned",
      "active": true,
      "steps": [
        {
          "id": "4e8a2c6d-7b1f-4d93-a5c0-8f2e1b7d6c54",
          "position": 1,
          "delay_days": 3,
          "body": "Hi {name}, your place in {project} is still here whenever you want it back: {link}"
        }
      ],
      "created_at": "2026-10-01T09:00:00+00:00",
      "updated_at": "2026-10-10T08:00:00+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.