Sequences

Get sequence by ID

Returns a single sequence by its unique identifier.

get/sequences/{id}

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/sequences/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: sequences:read)

Path parameters

idstring uuid required

Unique identifier for the sequence

Query parameters

includestring[]

Comma-separated relations to expand inline (owner, sequenceSteps). Max 3.

Response

Successful response

idstring uuid required

Unique identifier for the sequence

namestring required

Name of the sequence

type'date' | 'interval' required

Type of sequence timing:

  • date: Steps are scheduled for specific dates
  • interval: Steps are scheduled based on intervals from enrollment
enabledboolean required

Whether the sequence is currently active

privacy'private' | 'team_visible' | 'team_editable' required

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 and treat private sequences as owner-only.

createdAtstring date-time required

When the sequence was created

updatedAtstring date-time required

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.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Q1 Outbound Campaign",
  "type": "interval",
  "enabled": true,
  "owner": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequenceSteps": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "privacy": "team_editable",
  "analytics": {
    "email": {
      "delivered": 412,
      "opened": 198,
      "clicked": 41,
      "replied": 23,
      "bounced": 7,
      "unsubscribed": 2
    },
    "calls": {
      "dialed": 380,
      "connected": 71,
      "meetings": 5
    },
    "linkedIn": {
      "connectionRequestsSent": 96,
      "connectionRequestsAccepted": 31,
      "messagesSent": 64,
      "repliesReceived": 12
    }
  },
  "tags": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440010",
      "name": "cold",
      "createdAt": "2026-01-12T09:30:00Z",
      "updatedAt": "2026-01-12T09:30:00Z"
    }
  ],
  "createdAt": "2026-01-12T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.