> ## 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: Get Sequence

> Get a Nooks sequence by its ID. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Get a Nooks sequence by its ID.

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

## 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_get_sequence',
  {
    "id": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute nooks_get_sequence --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "name": "Example",
    "type": "date",
    "enabled": true,
    "owner": {
      "id": "id_123",
      "_href": "example"
    },
    "sequenceSteps": [
      {
        "id": "id_123",
        "_href": "example"
      }
    ],
    "privacy": "private",
    "createdAt": "2026-01-15T12:00:00Z",
    "updatedAt": "2026-01-15T12:00:00Z"
  }
}
```

Use `deepline describe nooks_get_sequence --json` for the latest machine-readable contract.

## Input reference

Returns a single sequence by its unique identifier. Example: `bash curl -X GET 'https://partner-api.nooks.in/v1/sequences/550e8400-e29b-41d4-a716-446655440000' \ -H "Authorization: Bearer nooks-api-..." ` With include: `bash curl -X GET 'https://partner-api.nooks.in/v1/sequences/550e8400-e29b-41d4-a716-446655440000?include=owner' \ -H "Authorization: Bearer nooks-api-..." `

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Unique identifier for the sequence Format: `uuid`. |
| `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 single sequence by its unique identifier. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequences/550e8400-e29b-41d4-a716-446655440000' \\ -H \"Authorization: Bearer nooks-api-...\" ``` With include: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequences/550e8400-e29b-41d4-a716-446655440000?include=owner' \\ -H \"Authorization: Bearer nooks-api-...\" ```",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the sequence",
        "format": "uuid"
      },
      "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": [
      "id"
    ],
    "additionalProperties": false
  }
  ````
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A sales sequence defining a series of outreach steps |
| `result.data.id` | `string` | Yes | — | Unique identifier for the sequence Format: `uuid`. |
| `result.data.name` | `string` | Yes | — | Name of the sequence |
| `result.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.enabled` | `boolean` | Yes | — | Whether the sequence is currently active |
| `result.data.owner` | `object` | Yes | — | A reference to a related resource |
| `result.data.owner.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.owner._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.sequenceSteps` | `array` | Yes | — | Steps in this sequence |
| `result.data.sequenceSteps[].id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.sequenceSteps[]._href` | `string` | Yes | — | API path to the referenced resource |
| `result.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.createdAt` | `string` | Yes | — | When the sequence was created Format: `date-time`. |
| `result.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.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": "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
      },
      "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.