> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reply.io/llms.txt
> Use this file to discover all available pages before exploring further.
# List all sequences
> _Requires the `sequences:read` scope (or a broader one that includes it)._
Returns a paginated list of all sequences in your account.
Results are ordered by creation date, newest first, unless overridden with `sortBy` / `sortDirection`.
## OpenAPI
````yaml /api-reference/bundled.yaml get /v3/sequences
openapi: 3.1.0
info:
version: 3.0.0
title: Reply API
description: API for managing email sequences, contacts, and automation workflows
servers:
- url: https://api.reply.io
security:
- bearerAuth: []
tags:
- name: User Account
description: Account information and authentication verification
- name: Accounts
description: Manage accounts (companies/organizations)
- name: AI SDR Insights
description: Read AI SDR insights for sequence contacts
- name: AI SDR Intent Signals
description: >-
Read Reply industry IDs and technology slugs used in AI SDR intent-signal
configuration (typeahead)
- name: AI SDR Sequences
description: >-
Manage AI SDR sequences and their AI SDR-specific settings — create, read
settings, partial update, autopilot enable/disable/force-start, approval
mode, generated step types, and playbook/knowledge-base connections
- name: AI SDR Web Search
description: Find contacts via AI-driven web search and review past searches
- name: Attachments
description: >-
Upload file attachments used across email templates, sequence steps, and
direct emails
- name: Account Lists
description: Manage account lists and account membership
- name: Background Jobs
description: >-
Track and cancel asynchronous background operations (e.g., email
validation)
- name: Custom Fields
description: Manage custom contact fields
- name: Direct Outreach
description: >-
Send one-off outreach directly to a contact outside of any sequence —
direct emails and LinkedIn connection requests, messages, InMails, and
voice messages
- name: Contact Blacklist Rules
description: Manage blacklist rules for domains, emails, and email exceptions
- name: Contact Enrichment
description: >-
Enrich contacts with emails, phone numbers, LinkedIn data, and AI-filled
custom fields
- name: Contact Lists
description: Manage contact lists and contact membership
- name: Contacts
description: Manage individual contacts
- name: Email Accounts
description: Manage email accounts used for sending and receiving
- name: Email Templates
description: Manage email templates and template folders
- name: Email Validations
description: Estimate and schedule asynchronous email validation jobs
- name: Holiday Calendars
description: Manage holiday calendars for scheduling
- name: Inbox
description: >-
Manage inbox threads and per-team thread categories — list/filter, read
state, replies, category assignment, and meeting-intent flagging
- name: LinkedIn Accounts
description: Manage LinkedIn accounts for outreach
- name: Live Data
description: >-
Find new contacts via Live Data searches and read typeahead values for the
Live Data / Autopilot filter sidebar
- name: AI SDR Knowledge Bases
description: >-
Manage AI SDR knowledge bases — collections of documents, links, reply
handlers, and reengagement cards that inform the agent's responses
- name: AI SDR Offers
description: >-
Manage AI SDR offers — bundles of company-context inputs (ICP, pain
points, value propositions, etc.) used to personalize outreach
- name: AI SDR Pending Approvals
description: >-
Review, send, regenerate, and provide feedback on AI-generated messages
awaiting human approval
- name: AI SDR Playbooks
description: >-
Manage AI SDR playbooks — tone, voice, and style guides applied during
personalized message generation
- name: Reports
description: >-
Generate and access performance reports across email, calls, tasks,
LinkedIn, and team performance
- name: Schedules
description: Manage email send schedules and timing
- name: Settings
description: Manage team and user settings
- name: Sequence Contacts
description: Manage contacts within sequences
- name: Sequence Email Accounts
description: Manage email accounts linked to sequences
- name: Sequence Folders
description: Organize sequences into folders
- name: Sequence LinkedIn Accounts
description: Manage LinkedIn accounts linked to sequences
- name: AI SDR Sequence Preview
description: >-
Read and regenerate per-contact previews of the messages a sequence will
send, and provide feedback on preview messages
- name: Sequence Steps
description: Manage individual steps in sequences
- name: Sequence Templates
description: Manage sequence templates
- name: Sequences
description: Manage email automation sequences
- name: AI SDR Strategist
description: Trigger AI Strategist runs
- name: Tasks
description: Manage tasks and to-do items
- name: Webhooks
description: Manage webhook subscriptions and inspect delivery history
paths:
/v3/sequences:
get:
tags:
- Sequences
summary: List all sequences
description: >-
_Requires the `sequences:read` scope (or a broader one that
includes it)._
Returns a paginated list of all sequences in your account.
Results are ordered by creation date, newest first, unless overridden
with `sortBy` / `sortDirection`.
operationId: GetSequences
parameters:
- name: top
in: query
required: false
description: Maximum number of items to return (default 25, max 1000)
schema:
type: integer
- name: skip
in: query
required: false
description: Number of items to skip
schema:
type: integer
- name: status
in: query
required: false
description: Filter sequences by status
schema:
type: string
enum:
- active
- paused
- new
- name: ownerUserId
in: query
required: false
description: Filter sequences by owner user ID
schema:
type: integer
- name: folderId
in: query
required: false
description: Filter sequences by folder ID
schema:
type: string
format: uuid
- name: isArchived
in: query
required: false
description: >-
Filter sequences by archive status. When `true`, returns only
archived sequences. When `false`, returns only non-archived
sequences. When omitted, returns all sequences regardless of archive
status.
schema:
type: boolean
- name: name
in: query
required: false
description: Search sequences by name (case-insensitive, partial match)
schema:
type: string
- name: createdAfter
in: query
required: false
description: Return only sequences created after this timestamp (ISO-8601).
schema:
type: string
format: date-time
- name: sortBy
in: query
required: false
description: >-
Field to sort results by. When omitted, results are ordered by
creation date.
schema:
type: string
enum:
- created
- name
- status
- name: sortDirection
in: query
required: false
description: >-
Sort direction. Requires `sortBy` to be set; supplying
`sortDirection` alone is rejected with 400. When omitted, `created`
sorts descending (newest first) while `name` and `status` sort
ascending.
schema:
type: string
enum:
- asc
- desc
responses:
'200':
description: List of sequences retrieved successfully
content:
application/json:
schema:
type: object
title: Sequence List Model
description: Response model for listing sequences with pagination
properties:
items:
type: array
description: Array of sequence items
items:
type: object
properties:
id:
type: integer
readOnly: true
description: Unique identifier for the sequence
ownerUserId:
type: integer
readOnly: true
description: Identifier of the user who owns the sequence
name:
type: string
description: Name of the sequence
created:
type: string
format: date-time
readOnly: true
description: Sequence creation timestamp with timezone offset
status:
type: string
enum:
- new
- active
- paused
readOnly: true
description: Current status of the sequence
isArchived:
type: boolean
readOnly: true
description: Indicates if the sequence is archived
health:
type: string
description: >-
Overall health status of the sequence. Indicates
whether the sequence can operate normally or has
issues that need attention.
- `healthy` — Sequence is functioning normally with
no issues
- `stalled` — Sequence has stalled and is not
progressing
- `degraded` — Sequence is running but with reduced
effectiveness
- `blocked` — Sequence cannot proceed due to
critical issues
enum:
- healthy
- stalled
- degraded
- blocked
readOnly: true
example:
id: 12345
ownerUserId: 42
name: Sales Outreach
created: '2024-03-08T10:00:00+00:00'
status: active
isArchived: false
health: healthy
hasMore:
type: boolean
description: Indicates if there are more items to fetch
example:
items:
- id: 12345
ownerUserId: 42
name: Sales Outreach
status: active
created: '2024-03-08T10:00:00+00:00'
isArchived: false
health: healthy
- id: 12346
ownerUserId: 42
name: Follow-up Campaign
status: paused
created: '2024-03-07T14:30:00+00:00'
isArchived: false
health: degraded
hasMore: true
'400':
description: >-
Invalid pagination parameters, invalid sort parameters, or other
business rejection
content:
application/problem+json:
schema:
allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope
and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
code:
type: string
description: >-
Stable, machine-readable error slug in the form
`"."`.
* `resource` is the camelCased domain — e.g.
`sequence`,
`contact`, `inboxThread`, `blacklistDomainRule`.
* `variant` is the camelCased specific failure
mode — e.g.
`notFound`, `forbidden`, `duplicateName`, `globalRuleReadOnly`.
Use `code` for programmatic error handling; use
`detail` for
user-facing messages. Slugs are stable across
server-side enum
reorderings and never change meaning under a given
resource.
pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$
example: sequence.notFound
title: Business Problem
description: >-
Domain error response carrying a stable, namespaced error
slug.
Emitted for most 4xx responses (business 400, 403, 404,
409, …) and
for 503 when a downstream dependency is unavailable.
- example:
title: Bad Request
status: 400
detail: Pagination parameters are invalid.
code: sequence.invalidPagination
examples:
invalid_pagination:
summary: Invalid pagination parameters
value:
title: Bad Request
status: 400
detail: Invalid requested page view.
code: sequence.invalidPagination
invalid_sort:
summary: Invalid sort parameters
value:
title: Bad Request
status: 400
detail: >-
Invalid sortBy value 'foo'. Allowed values: created, name,
status.
code: sequence.invalidSort
'401':
description: >-
Unauthorized. The response body is empty; check the
`WWW-Authenticate` header for the expected scheme.
content:
application/problem+json:
schema:
allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized (auth
middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope and
add additional
fields — see `business-problem.model.yaml` (adds `code`
slug) and
`validation-problem.model.yaml` (adds `errors[]` array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- example:
title: Unauthorized
status: 401
detail: Authentication credentials are missing or invalid.
'403':
description: User lacks permission to view sequences
content:
application/problem+json:
schema:
allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope
and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
code:
type: string
description: >-
Stable, machine-readable error slug in the form
`"."`.
* `resource` is the camelCased domain — e.g.
`sequence`,
`contact`, `inboxThread`, `blacklistDomainRule`.
* `variant` is the camelCased specific failure
mode — e.g.
`notFound`, `forbidden`, `duplicateName`, `globalRuleReadOnly`.
Use `code` for programmatic error handling; use
`detail` for
user-facing messages. Slugs are stable across
server-side enum
reorderings and never change meaning under a given
resource.
pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$
example: sequence.notFound
title: Business Problem
description: >-
Domain error response carrying a stable, namespaced error
slug.
Emitted for most 4xx responses (business 400, 403, 404,
409, …) and
for 503 when a downstream dependency is unavailable.
- example:
title: Forbidden
status: 403
detail: You do not have permission to access this resource.
code: sequence.forbidden
example:
title: Forbidden
status: 403
detail: You do not have permission to view sequences.
code: sequence.forbidden
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying
schema:
type: integer
minimum: 1
content:
application/problem+json:
schema:
allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized (auth
middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope and
add additional
fields — see `business-problem.model.yaml` (adds `code`
slug) and
`validation-problem.model.yaml` (adds `errors[]` array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
example:
title: Too Many Requests
status: 429
detail: Rate limit exceeded. Retry after 60 seconds.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Authenticate every request with a Bearer token. Pass your Reply API key
in the
`Authorization` header:
```
Authorization: Bearer
```
Get your API key from the Reply dashboard: **Settings → API Key**.
````