Nooks: Get Sequence State

Get sequence state by ID.

Tool ID: nooks_get_sequence_state

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

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

deepline tools execute nooks_get_sequence_state --input '{
  "id": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "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 tools get 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.

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

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Nooks: Get Sequence State

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation