subsequences

List all subsequences under a parent sequence

List every subsequence attached to a parent sequence, including progress (<code>1</code>=Active, <code>2</code>=Paused, <code>3</code>=Finished), total steps, and engagement metrics.

<strong>Filters</strong> — <code>progress</code> (repeating enum, e.g. <code>?progress=1&progress=2</code>), <code>search</code> (partial title match), <code>owners</code> (repeating hashid-encoded user IDs). Omitting <code>owners</code> returns every subsequence scoped to the authenticated account.

Use the returned <code>id</code> as <code>subsequenceId</code> in Get Subsequence Settings or Update Subsequence.

get/v1/sequences/{sequenceId}/subsequences

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/sequences/:sequenceId/subsequences/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sequenceIdstring required

Hashid-encoded ID of the parent sequence.

Query parameters

progressstring[]

Filter by subsequence progress. Accepts repeating values (<code>?progress=1&progress=2</code>). <code>1</code>=Active, <code>2</code>=Paused, <code>3</code>=Finished.

searchstring

Filter by subsequence title (partial match).

ownersstring[]

Filter by owner user IDs (hashid-encoded strings). Accepts repeating values (<code>?owners=abc&owners=def</code>). Omit to return all subsequences scoped to the authenticated account.

Response

Subsequences fetched successfully

Changes

No recorded changes to this operation across all 4 revisions of this API.