SequenceSteps

Get sequence step by ID

Returns a single sequence step by its unique identifier.

get/sequenceSteps/{id}

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/sequenceSteps/{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: sequence-steps:read)

Path parameters

idstring uuid required

Unique identifier for the sequence step

Query parameters

includestring[]

Comma-separated relations to expand inline (sequence, template). Max 3.

Response

Successful response

idstring uuid required

Unique identifier for the sequence step

orderinteger required

Zero-based position of this step within the sequence

namestring nullable required

Optional display name for this step, or null if unnamed

intervalinteger nullable required

Number of minutes to wait before executing this step (null for the first step). POST/PATCH /sequenceSteps always require a non-null interval. null is a read-only state you cannot currently set through this API.

action'call' | 'manual_email' | 'auto_email' | 'manual_email_reply' | 'auto_email_reply' | 'basic_task' | 'linkedin_connection_request' | 'manual_linkedin_connection_request' | 'manual_linkedin_message' | 'automatic_linkedin_message' | 'manual_sms' | 'auto_sms' required

Type of action for this step:

  • call: Phone call task
  • manual_email: Manually composed email
  • auto_email: Automatically sent email
  • manual_email_reply: Manual email reply
  • auto_email_reply: Automatic email reply
  • basic_task: Generic manual task
  • linkedin_connection_request: LinkedIn connection request
  • manual_linkedin_connection_request: Manual LinkedIn connection request
  • manual_linkedin_message: Manual LinkedIn message
  • automatic_linkedin_message: Automatically sent LinkedIn message
  • manual_sms: Manual SMS message
  • auto_sms: Automatically sent SMS message
notestring nullable required

Optional note or instructions for this step

hasAbVariantsboolean required

Whether this step is running an A/B test (i.e. has multiple variants).

createdAtstring date-time required

When the step was created

updatedAtstring date-time required

When the step was last updated

Example response

{
  "id": "aa0e8400-e29b-41d4-a716-446655440030",
  "name": "Intro email",
  "interval": 4320,
  "action": "auto_email",
  "note": "Initial outreach email",
  "sequence": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "template": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "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
    }
  },
  "createdAt": "2025-10-01T10:00:00.000Z",
  "updatedAt": "2025-10-01T10:00:00.000Z"
}

Changes

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