> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Nooks: List Sequences

> List outreach sequences in Nooks, filtered by name. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List outreach sequences in Nooks, filtered by name.

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ````json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "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-...\" ```",
    "properties": {
      "page": {
        "type": "object",
        "description": "Number of items per page (max 100)",
        "properties": {
          "size": {
            "type": "integer",
            "description": "Number of items per page (max 100)",
            "default": 50,
            "minimum": 1,
            "maximum": 100
          },
          "after": {
            "type": "string",
            "description": "Cursor for fetching the next page. Opaque token returned by the API in `links.next`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
          },
          "before": {
            "type": "string",
            "description": "Cursor for fetching the previous page. Opaque token returned by the API in `links.prev`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "filter": {
        "type": "object",
        "description": "Filter sequences by exact name match",
        "properties": {
          "name": {
            "type": "string",
            "description": "Filter sequences by exact name match"
          },
          "type": {
            "type": "string",
            "description": "Filter by sequence type. Valid values: date, interval",
            "enum": [
              "date",
              "interval"
            ]
          },
          "updatedAt": {
            "type": "object",
            "description": "Filter by minimum updatedAt (ISO 8601 datetime)",
            "properties": {
              "gte": {
                "type": "string",
                "description": "Filter by minimum updatedAt (ISO 8601 datetime)",
                "format": "date-time"
              },
              "lt": {
                "type": "string",
                "description": "Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)",
                "format": "date-time"
              }
            },
            "required": [],
            "additionalProperties": false
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "include": {
        "type": "array",
        "description": "Comma-separated relations to expand inline. Valid values: `owner`, `sequenceSteps`. Max 3.",
        "maxItems": 3,
        "items": {
          "type": "string",
          "enum": [
            "owner",
            "sequenceSteps"
          ]
        }
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ````
</details>

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

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "A sales sequence defining a series of outreach steps",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the sequence",
                  "format": "uuid"
                },
                "name": {
                  "type": "string",
                  "description": "Name of the sequence"
                },
                "type": {
                  "type": "string",
                  "description": "Type of sequence timing: - `date`: Steps are scheduled for specific dates - `interval`: Steps are scheduled based on intervals from enrollment",
                  "enum": [
                    "date",
                    "interval"
                  ]
                },
                "enabled": {
                  "type": "boolean",
                  "description": "Whether the sequence is currently active"
                },
                "owner": {
                  "type": "object",
                  "description": "A reference to a related resource",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the referenced resource"
                    },
                    "_href": {
                      "type": "string",
                      "description": "API path to the referenced resource"
                    }
                  },
                  "required": [
                    "id",
                    "_href"
                  ],
                  "additionalProperties": false
                },
                "sequenceSteps": {
                  "type": "array",
                  "description": "Steps in this sequence",
                  "items": {
                    "type": "object",
                    "description": "A reference to a related resource",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Unique identifier of the referenced resource"
                      },
                      "_href": {
                        "type": "string",
                        "description": "API path to the referenced resource"
                      }
                    },
                    "required": [
                      "id",
                      "_href"
                    ],
                    "additionalProperties": false
                  }
                },
                "privacy": {
                  "type": "string",
                  "description": "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.",
                  "enum": [
                    "private",
                    "team_visible",
                    "team_editable"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "description": "When the sequence was created",
                  "format": "date-time"
                },
                "updatedAt": {
                  "type": "string",
                  "description": "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"
                }
              },
              "required": [
                "id",
                "name",
                "type",
                "enabled",
                "owner",
                "sequenceSteps",
                "privacy",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "links": {
            "type": "object",
            "description": "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.",
            "properties": {
              "first": {
                "type": "string",
                "description": "URL for the first page",
                "format": "uri-reference"
              },
              "prev": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "URL for the previous page (null if on first page)",
                "format": "uri-reference"
              },
              "next": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "URL for the next page (null if on last page)",
                "format": "uri-reference"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Nooks provider guide](https://deepline.com/docs/providers/nooks/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.