NudgeLink Sequences API
The sequences API from NudgeLink — 8 operation(s) for sequences.
The sequences API from NudgeLink — 8 operation(s) for sequences.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nudgelink-co:nudgelink-co-sequences-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: NudgeLink Sequences API
version: 0.1.0
tags:
- name: Sequences
paths:
/api/v1/sequences:
get:
tags:
- Sequences
summary: List Sequences
description: Return all sequences for the current user.
operationId: list_sequences_api_v1_sequences_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/SequenceOut'
type: array
title: Response List Sequences Api V1 Sequences Get
security:
- HTTPBearer: []
post:
tags:
- Sequences
summary: Start Sequence
operationId: start_sequence_api_v1_sequences_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSequenceRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SequenceOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/sequences/bulk-start:
post:
tags:
- Sequences
summary: Bulk Start Sequences
description: 'Start outreach for exactly the named leads that don''t have a sequence
yet. Auto-picks the best available LinkedIn account.
Audit 2026-09-29 §2: this used to take no body and start EVERY lead in the
account without a sequence, while the leads page counted only the new
leads in the current filter — "Start all (1)" on campaign A could start
campaign B''s ten too. The page now sends the leads it counted; ids that are
not the caller''s, or already in outreach, are ignored.'
operationId: bulk_start_sequences_api_v1_sequences_bulk_start_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkStartRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/SequenceOut'
type: array
title: Response Bulk Start Sequences Api V1 Sequences Bulk Start Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/sequences/{sequence_id}:
get:
tags:
- Sequences
summary: Get Sequence
operationId: get_sequence_api_v1_sequences__sequence_id__get
security:
- HTTPBearer: []
parameters:
- name: sequence_id
in: path
required: true
schema:
type: string
format: uuid
title: Sequence Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SequenceOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sequences/{sequence_id}/pause:
post:
tags:
- Sequences
summary: Pause Sequence
operationId: pause_sequence_api_v1_sequences__sequence_id__pause_post
security:
- HTTPBearer: []
parameters:
- name: sequence_id
in: path
required: true
schema:
type: string
format: uuid
title: Sequence Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SequenceOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sequences/{sequence_id}/resume:
post:
tags:
- Sequences
summary: Resume Sequence
operationId: resume_sequence_api_v1_sequences__sequence_id__resume_post
security:
- HTTPBearer: []
parameters:
- name: sequence_id
in: path
required: true
schema:
type: string
format: uuid
title: Sequence Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SequenceOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sequences/{sequence_id}/stop:
post:
tags:
- Sequences
summary: Stop Sequence
operationId: stop_sequence_api_v1_sequences__sequence_id__stop_post
security:
- HTTPBearer: []
parameters:
- name: sequence_id
in: path
required: true
schema:
type: string
format: uuid
title: Sequence Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SequenceOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sequences/{sequence_id}/trigger:
post:
tags:
- Sequences
summary: Trigger Sequence
description: 'Manually advance a sequence one step — runs inline without Celery.
Useful for demo / testing when no worker is deployed.'
operationId: trigger_sequence_api_v1_sequences__sequence_id__trigger_post
security:
- HTTPBearer: []
parameters:
- name: sequence_id
in: path
required: true
schema:
type: string
format: uuid
title: Sequence Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Trigger Sequence Api V1 Sequences Sequence Id Trigger Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sequences/{sequence_id}/skip-step:
post:
tags:
- Sequences
summary: Skip Step
description: 'Skip the current warmup step without performing it (P0-4 / F-6).
Advances ``current_step`` to the next step and re-arms it as due now, with
no LinkedIn action and no credit charge. Only the optional warmup steps
(view / like / comment) are skippable — real outreach steps must run.'
operationId: skip_step_api_v1_sequences__sequence_id__skip_step_post
security:
- HTTPBearer: []
parameters:
- name: sequence_id
in: path
required: true
schema:
type: string
format: uuid
title: Sequence Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SequenceOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
OutreachStep:
type: string
enum:
- pending
- warmup_view
- warmup_like
- warmup_comment
- linkedin_invite
- linkedin_followup_1
- linkedin_followup_2
- email_1
- email_2
- completed
title: OutreachStep
SequenceOut:
properties:
id:
type: string
format: uuid
title: Id
lead_id:
type: string
format: uuid
title: Lead Id
account_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Account Id
current_step:
$ref: '#/components/schemas/OutreachStep'
status:
$ref: '#/components/schemas/SequenceStatus'
mode:
$ref: '#/components/schemas/SequenceMode'
warmup_done:
type: boolean
title: Warmup Done
next_action_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Next Action At
pause_reason:
anyOf:
- type: string
- type: 'null'
title: Pause Reason
stopped_reason:
anyOf:
- type: string
- type: 'null'
title: Stopped Reason
steps_done:
type: integer
title: Steps Done
steps_total:
type: integer
title: Steps Total
comment_posted:
type: boolean
title: Comment Posted
default: false
preview_pending:
type: boolean
title: Preview Pending
default: false
invite_accepted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Invite Accepted At
type: object
required:
- id
- lead_id
- account_id
- current_step
- status
- mode
- warmup_done
- next_action_at
- pause_reason
- stopped_reason
- steps_done
- steps_total
title: SequenceOut
SequenceStatus:
type: string
enum:
- active
- paused
- completed
- stopped
title: SequenceStatus
SequenceMode:
type: string
enum:
- auto
- preview
- manual
title: SequenceMode
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
CreateSequenceRequest:
properties:
lead_id:
type: string
format: uuid
title: Lead Id
account_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Account Id
mode:
$ref: '#/components/schemas/SequenceMode'
default: preview
type: object
required:
- lead_id
title: CreateSequenceRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
BulkStartRequest:
properties:
lead_ids:
items:
type: string
format: uuid
type: array
maxItems: 1000
minItems: 1
title: Lead Ids
type: object
required:
- lead_ids
title: BulkStartRequest
description: 'The leads "Start all" counted (audit 2026-09-29 §2) — the action must
touch exactly the set the button showed.'
securitySchemes:
HTTPBearer:
type: http
scheme: bearer