Recovery Sequences

List a sequence's enrolments

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.

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

sequencestring uuid required

The sequence, resolved within the project by the route binder.

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.

Keep only the passages that ended this way: reactivated (won back), opted_out, disabled or deleted. Omit for every passage, open ones included.

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 passages, the newest first, each with its member.

Changes

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