List sequences

GET

/api/nova/sequences/list

Returns the account's drip sequences, newest first. By default only live (non-archived) sequences are returned; pass archived=true to list archived ones instead. An optional type filter limits the list to one audience (CANDIDATE, CONTACT, LEAD or OPPORTUNITY); sequences of type ALL match any filter. Each sequence includes id, name, type (the record type it enrols; ALL when it takes any), status (DRAFT, DISABLED or LIVE), archived, members, stepsCount, sendEmail, sendSMS, sendWhatsApp, addTask, ownerId, ownerName, createdOn and modifiedOn. Use the id with the enrol endpoint. Returns 401 if the API key is invalid.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Query Parameters

apiKey*

apiKey

Type

string

Required

archived

archived

Type

boolean

Default

false

type

type

Type

string

Responses

OK

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"additionalProperties": {

  

  

  

}

  

  

}

  

],

  

"error": "string",

  

"message": "string",

  

"page": 0,

  

"requestId": "string",

  

"size": 0,

  

"success": true,

  

"total": 0

}

GET

/api/nova/sequences/list

Playground

Authorization

privateApiKey

Variables

Key

Value

apiKey*

archived

type

Samples