> ## 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 State

> Get one prospect's Nooks sequence enrollment and its current state by ID. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Get one prospect's Nooks sequence enrollment and its current state by ID.

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

## 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_state',
  {
    "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_state --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",
    "state": "active",
    "sequence": {
      "id": "id_123",
      "_href": "example"
    },
    "prospect": {
      "id": "id_123",
      "_href": "example"
    },
    "creator": {
      "id": "id_123",
      "_href": "example"
    },
    "owner": {
      "id": "id_123",
      "_href": "example"
    },
    "sequenceStep": {
      "id": "id_123",
      "_href": "example"
    },
    "createdAt": "2026-01-15T12:00:00Z",
    "updatedAt": "2026-01-15T12:00:00Z"
  }
}
```

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

## Input reference

Returns a single sequence state by its unique identifier. Example: `bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceStates/880e8400-e29b-41d4-a716-446655440010' \ -H "Authorization: Bearer nooks-api-..." `

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Unique identifier for the sequence state Format: `uuid`. |
| `payload.include` | `array` | No | — | Comma-separated relations to expand inline. Valid values: `sequence`, `prospect`, `creator`, `sequenceStep`. 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 state by its unique identifier. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceStates/880e8400-e29b-41d4-a716-446655440010' \\ -H \"Authorization: Bearer nooks-api-...\" ```",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the sequence state",
        "format": "uuid"
      },
      "include": {
        "type": "array",
        "description": "Comma-separated relations to expand inline. Valid values: `sequence`, `prospect`, `creator`, `sequenceStep`. Max 3.",
        "maxItems": 3,
        "items": {
          "type": "string",
          "enum": [
            "sequence",
            "prospect",
            "creator",
            "sequenceStep"
          ]
        }
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ````
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A prospect's enrollment in a sequence |
| `result.data.id` | `string` | Yes | — | Unique identifier for the sequence state Format: `uuid`. |
| `result.data.state` | `"active" \| "paused" \| "finished"` | Yes | — | Current state of the enrollment: - `active`: Prospect is actively progressing through the sequence - `paused`: Enrollment is temporarily paused - `finished`: Enrollment has completed or been stopped Allowed: `active`, `paused`, `finished`. |
| `result.data.sequence` | `object` | Yes | — | A reference to a related resource |
| `result.data.sequence.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.sequence._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.prospect` | `object` | Yes | — | A reference to a related resource |
| `result.data.prospect.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.prospect._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.account` | `object \| null` | No | — | A reference to a related resource |
| `result.data.account.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.account._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.creator` | `object` | Yes | — | A reference to a related resource |
| `result.data.creator.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.creator._href` | `string` | Yes | — | API path to the referenced resource |
| `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.sequenceStep` | `object \| null` | Yes | — | A reference to a related resource |
| `result.data.sequenceStep.id` | `string` | Yes | — | Unique identifier of the referenced resource |
| `result.data.sequenceStep._href` | `string` | Yes | — | API path to the referenced resource |
| `result.data.createdAt` | `string` | Yes | — | When the enrollment was created Format: `date-time`. |
| `result.data.updatedAt` | `string` | Yes | — | When the enrollment was last updated 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 prospect's enrollment in a sequence",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the sequence state",
            "format": "uuid"
          },
          "state": {
            "type": "string",
            "description": "Current state of the enrollment: - `active`: Prospect is actively progressing through the sequence - `paused`: Enrollment is temporarily paused - `finished`: Enrollment has completed or been stopped",
            "enum": [
              "active",
              "paused",
              "finished"
            ]
          },
          "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
          },
          "prospect": {
            "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
          },
          "account": {
            "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
          },
          "creator": {
            "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
          },
          "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
          },
          "sequenceStep": {
            "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
          },
          "createdAt": {
            "type": "string",
            "description": "When the enrollment was created",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "description": "When the enrollment was last updated",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "state",
          "sequence",
          "prospect",
          "creator",
          "owner",
          "sequenceStep",
          "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.