> ## 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 Sequence Steps

> List the steps of Nooks sequences, filtered by sequence. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the steps of Nooks sequences, filtered by sequence.

> [!NOTE]
>
> Tool ID: `nooks_list_sequence_steps`

## Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably.

Read the live contract before you execute this action:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe nooks_list_sequence_steps --json
```

## Example response

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

## Input reference

Returns a paginated list of sequence steps. Supports filtering by step IDs or by sequence. Example: `bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceSteps?page[size]=50' \ -H "Authorization: Bearer nooks-api-..." ` Filter by sequence: `bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceSteps?filter[sequence][id]=550e8400-e29b-41d4-a716-446655440000' \ -H "Authorization: Bearer nooks-api-..." ` Filter by IDs: `bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceSteps?filter[id]=UUID1,UUID2' \ -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 by IDs (comma-separated UUIDs). An empty value is treated as "no filter". |
| `payload.include` | `array` | No | — | Comma-separated relations to expand inline. Valid values: `sequence`, `template`. 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 sequence steps. Supports filtering by step IDs or by sequence. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceSteps?page[size]=50' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by sequence: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceSteps?filter[sequence][id]=550e8400-e29b-41d4-a716-446655440000' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by IDs: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceSteps?filter[id]=UUID1,UUID2' \\ -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 by IDs (comma-separated UUIDs). An empty value is treated as \"no filter\".",
        "properties": {
          "id": {
            "type": "string",
            "description": "Filter by IDs (comma-separated UUIDs). An empty value is treated as \"no filter\".",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}(,[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})*)?$"
          },
          "sequence": {
            "type": "object",
            "description": "Filter steps belonging to a specific sequence",
            "properties": {
              "id": {
                "type": "string",
                "description": "Filter steps belonging to a specific sequence",
                "format": "uuid"
              }
            },
            "required": [],
            "additionalProperties": false
          },
          "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: `sequence`, `template`. Max 3.",
        "maxItems": 3,
        "items": {
          "type": "string",
          "enum": [
            "sequence",
            "template"
          ]
        }
      }
    },
    "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 step Format: `uuid`. |
| `result.data.data[].order` | `integer` | Yes | — | Zero-based position of this step within the sequence |
| `result.data.data[].name` | `string \| null` | Yes | — | Optional display name for this step, or null if unnamed |
| `result.data.data[].interval` | `integer \| null` | Yes | — | Number of minutes to wait before executing this step (null for the first step) |
| `result.data.data[].action` | `"call" \| "manual_email" \| "auto_email" \| "manual_email_reply" \| "auto_email_reply" \| "basic_task" \| "linkedin_connection_request" \| "manual_linkedin_connection_request" \| "manual_linkedin_message" \| "automatic_linkedin_message" \| "manual_sms" \| "auto_sms"` | Yes | — | Type of action for this step: - `call`: Phone call task - `manual_email`: Manually composed email - `auto_email`: Automatically sent email - `manual_email_reply`: Manual email reply - `auto_email_reply`: Automatic email reply - `basic_task`: Generic manual task - `linkedin_connection_request`: LinkedIn connection request - `manual_linkedin_connection_request`: Manual LinkedIn connection request - `manual_linkedin_message`: Manual LinkedIn message - `automatic_linkedin_message`: Automatically See the live schema for the complete constraint. |
| `result.data.data[].note` | `string \| null` | Yes | — | Optional note or instructions for this step |
| `result.data.data[].sequence` | `object` | Yes | — | A reference to a related resource |
| `result.data.data[].sequence.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.data[].sequence._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.data[].template` | `object \| null` | Yes | — | A reference to a related resource |
| `result.data.data[].template.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.data[].template._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.data[].hasAbVariants` | `boolean` | Yes | — | Whether this step is running an A/B test (i.e. has multiple variants). |
| `result.data.data[].createdAt` | `string` | Yes | — | When the step was created Format: `date-time`. |
| `result.data.data[].updatedAt` | `string` | Yes | — | When the step was last updated 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 step within a sales sequence defining an action to perform",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the sequence step",
                  "format": "uuid"
                },
                "order": {
                  "type": "integer",
                  "description": "Zero-based position of this step within the sequence"
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Optional display name for this step, or null if unnamed"
                },
                "interval": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "description": "Number of minutes to wait before executing this step (null for the first step)"
                },
                "action": {
                  "type": "string",
                  "description": "Type of action for this step: - `call`: Phone call task - `manual_email`: Manually composed email - `auto_email`: Automatically sent email - `manual_email_reply`: Manual email reply - `auto_email_reply`: Automatic email reply - `basic_task`: Generic manual task - `linkedin_connection_request`: LinkedIn connection request - `manual_linkedin_connection_request`: Manual LinkedIn connection request - `manual_linkedin_message`: Manual LinkedIn message - `automatic_linkedin_message`: Automatically sent LinkedIn message - `manual_sms`: Manual SMS message - `auto_sms`: Automatically sent SMS message",
                  "enum": [
                    "call",
                    "manual_email",
                    "auto_email",
                    "manual_email_reply",
                    "auto_email_reply",
                    "basic_task",
                    "linkedin_connection_request",
                    "manual_linkedin_connection_request",
                    "manual_linkedin_message",
                    "automatic_linkedin_message",
                    "manual_sms",
                    "auto_sms"
                  ]
                },
                "note": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Optional note or instructions for this step"
                },
                "sequence": {
                  "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
                },
                "template": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "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
                },
                "hasAbVariants": {
                  "type": "boolean",
                  "description": "Whether this step is running an A/B test (i.e. has multiple variants)."
                },
                "createdAt": {
                  "type": "string",
                  "description": "When the step was created",
                  "format": "date-time"
                },
                "updatedAt": {
                  "type": "string",
                  "description": "When the step was last updated",
                  "format": "date-time"
                }
              },
              "required": [
                "id",
                "order",
                "name",
                "interval",
                "action",
                "note",
                "sequence",
                "template",
                "hasAbVariants",
                "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.