SequenceStates

Get sequence state by ID

Returns a single sequence state by its unique identifier.

get/sequenceStates/{id}

Request

Base URL: https://partner-api.nooks.in/v1
URL: https://partner-api.nooks.in/v1/sequenceStates/{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-states:read)

Path parameters

idstring uuid required

Unique identifier for the sequence state

Query parameters

includestring[]

Comma-separated relations to expand inline. Valid values: sequence, prospect, creator, sequenceStep. Max 3.

Response

Successful response

idstring uuid required

Unique identifier for the sequence state

state'active' | 'paused' | 'finished' | 'pending_start' required

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
pending_start: Enrolled but queued behind the sequence's start throttle; no tasks exist yet and nothing has been sent

createdAtstring date-time required

When the enrollment was created

updatedAtstring date-time required

When the enrollment was last updated

Example response

{
  "id": "880e8400-e29b-41d4-a716-446655440010",
  "state": "active",
  "sequence": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "prospect": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "creator": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "owner": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "sequenceStep": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
  },
  "createdAt": "2025-11-01T10:00:00.000Z",
  "updatedAt": "2025-11-05T14:30:00.000Z"
}

Changes

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