Nooks: List Sequences

List outreach sequences in Nooks, filtered by name.

Tool ID: nooks_list_sequences

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'nooks_list_sequences',
  {
    "page": {
      "size": 50,
      "after": "cursor_123",
      "before": "cursor_123"
    },
    "filter": {
      "name": "Example",
      "type": "date",
      "updatedAt": {
        "gte": "2026-01-15T12:00:00Z",
        "lt": "2026-01-15T12:00:00Z"
      }
    },
    "include": [
      "owner"
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute nooks_list_sequences --input '{
  "page": {
    "size": 50,
    "after": "cursor_123",
    "before": "cursor_123"
  },
  "filter": {
    "name": "Example",
    "type": "date",
    "updatedAt": {
      "gte": "2026-01-15T12:00:00Z",
      "lt": "2026-01-15T12:00:00Z"
    }
  },
  "include": [
    "owner"
  ]
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe nooks_list_sequences --json for the complete live contract.

Input reference

Returns a paginated list of sequences. Example:

bash curl -X GET 'https://partner-api.nooks.in/v1/sequences?filter[name]=Q1+Outbound+Campaign' \ -H "Authorization: Bearer nooks-api-..."

With include:

bash curl -X GET 'https://partner-api.nooks.in/v1/sequences?include=owner,sequenceSteps' \ -H "Authorization: Bearer nooks-api-..."

Name	Type	Required	Default	Details
`payload.page`	`object`	No	—	Number of items per page (max 100)
`payload.filter`	`object`	No	—	Filter sequences by exact name match
`payload.include`	`array`	No	—	Comma-separated relations to expand inline. Valid values: `owner`, `sequenceSteps`. Max 3. Maximum items: 3.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`array`	No	—	—
`result.data.data[].id`	`string`	Yes	—	Unique identifier for the sequence Format: `uuid`.
`result.data.data[].name`	`string`	Yes	—	Name of the sequence
`result.data.data[].type`	`"date" \| "interval"`	Yes	—	Type of sequence timing: - `date`: Steps are scheduled for specific dates - `interval`: Steps are scheduled based on intervals from enrollment Allowed: `date`, `interval`.
`result.data.data[].enabled`	`boolean`	Yes	—	Whether the sequence is currently active
`result.data.data[].owner`	`object`	Yes	—	A reference to a related resource
`result.data.data[].owner.id`	`string`	Yes	—	Unique identifier of the referenced resource
`result.data.data[].owner._href`	`string`	Yes	—	API path to the referenced resource
`result.data.data[].sequenceSteps`	`array`	Yes	—	Steps in this sequence
`result.data.data[].sequenceSteps[].id`	`string`	Yes	—	Unique identifier of the referenced resource
`result.data.data[].sequenceSteps[]._href`	`string`	Yes	—	API path to the referenced resource
`result.data.data[].privacy`	`"private" \| "team_visible" \| "team_editable"`	Yes	—	Privacy level of the sequence: - `private`: Only the owner (and workspace managers/admins) can view or edit it in Nooks. - `team_visible`: All team members can view and enroll prospects; only the owner can edit. - `team_editable`: All team members can view, enroll prospects, and edit (the default). Always present. Integrations acting on behalf of a user should respect this — treat `private` sequences as owner-only. Allowed: `private`, `team_visible`, `team_editable`.
`result.data.data[].createdAt`	`string`	Yes	—	When the sequence was created Format: `date-time`.
`result.data.data[].updatedAt`	`string`	Yes	—	Effective last-updated time of the sequence: the most recent of the sequence’s own update time and the update time of any of its steps. `filter[updatedAt]` applies to this same derived value. Format: `date-time`.
`result.data.links`	`object`	No	—	Pagination links for navigating through results. Links are returned as relative references (path + query) that should be resolved against the base URL of the request.
`result.data.links.first`	`string`	No	—	URL for the first page Format: `uri-reference`.
`result.data.links.prev`	`string \| null`	No	—	URL for the previous page (null if on first page) Format: `uri-reference`.
`result.data.links.next`	`string \| null`	No	—	URL for the next page (null if on last page) Format: `uri-reference`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation