Nooks: Get Sequence

Get sequence by ID.

Tool ID: nooks_get_sequence

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

console.log(result.toolResponse.raw);

CLI

deepline tools execute nooks_get_sequence --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",
    "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 tools get 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.

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

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

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