> ## 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: Inputs, Cost & CLI Example

> List sequences. Nooks Nooks List Sequences docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=nooks_list_sequences:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name              | Type     | Required | Default | Description                                                                                |
| ----------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `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. |

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

  ### Input JSON Schema

  ````json theme={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute nooks_list_sequences --payload '{}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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