> ## 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 schedules
> _Requires the `sequences:read` scope (or a broader one that includes it)._
Returns all schedules for the authenticated user.
## OpenAPI
````yaml /api-reference/bundled.yaml get /v3/schedules
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/schedules:
get:
tags:
- Schedules
summary: List schedules
description: >-
_Requires the `sequences:read` scope (or a broader one that
includes it)._
Returns all schedules for the authenticated user.
operationId: ListSchedules
responses:
'200':
description: List of schedules
content:
application/json:
schema:
type: array
items:
type: object
title: Schedule
description: Full representation of a schedule with timing configuration.
properties:
id:
type: integer
description: Unique identifier for the schedule
readOnly: true
name:
type: string
description: Name of the schedule
timezoneId:
type: string
description: IANA timezone identifier (e.g., "America/New_York")
excludeHolidays:
type: boolean
description: >-
Whether to skip sending on holidays from linked
calendars
useProspectTimezone:
type: boolean
description: >-
Whether to use the prospect's timezone instead of the
schedule timezone
useFollowUpSchedule:
type: boolean
description: Whether a separate follow-up schedule is enabled
mainTimings:
type: array
items:
type: object
title: ScheduleTiming
description: Timing configuration for a single day of the week.
properties:
weekDay:
type: string
description: Day of the week
enum:
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
- Sunday
isActive:
type: boolean
description: Whether sending is enabled on this day
timeRanges:
type: array
items:
type: object
title: ScheduleTimingTimeRange
description: A time range within a day.
properties:
fromTime:
type: object
title: ScheduleTime
description: >-
A time of day represented as hour and
minute.
properties:
hour:
type: integer
minimum: 0
maximum: 23
description: Hour of the day (0-23)
minute:
type: integer
minimum: 0
maximum: 59
description: Minute of the hour (0-59)
required:
- hour
- minute
example:
hour: 9
minute: 30
toTime:
type: object
title: ScheduleTime
description: >-
A time of day represented as hour and
minute.
properties:
hour:
type: integer
minimum: 0
maximum: 23
description: Hour of the day (0-23)
minute:
type: integer
minimum: 0
maximum: 59
description: Minute of the hour (0-59)
required:
- hour
- minute
example:
hour: 9
minute: 30
required:
- fromTime
- toTime
example:
fromTime:
hour: 9
minute: 0
toTime:
hour: 17
minute: 0
description: Active time ranges for this day
required:
- weekDay
- isActive
example:
weekDay: Monday
isActive: true
timeRanges:
- fromTime:
hour: 9
minute: 0
toTime:
hour: 17
minute: 0
description: Primary schedule timings for each day of the week
followUpTimings:
type: array
items:
type: object
title: ScheduleTiming
description: Timing configuration for a single day of the week.
properties:
weekDay:
type: string
description: Day of the week
enum:
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
- Sunday
isActive:
type: boolean
description: Whether sending is enabled on this day
timeRanges:
type: array
items:
type: object
title: ScheduleTimingTimeRange
description: A time range within a day.
properties:
fromTime:
type: object
title: ScheduleTime
description: >-
A time of day represented as hour and
minute.
properties:
hour:
type: integer
minimum: 0
maximum: 23
description: Hour of the day (0-23)
minute:
type: integer
minimum: 0
maximum: 59
description: Minute of the hour (0-59)
required:
- hour
- minute
example:
hour: 9
minute: 30
toTime:
type: object
title: ScheduleTime
description: >-
A time of day represented as hour and
minute.
properties:
hour:
type: integer
minimum: 0
maximum: 23
description: Hour of the day (0-23)
minute:
type: integer
minimum: 0
maximum: 59
description: Minute of the hour (0-59)
required:
- hour
- minute
example:
hour: 9
minute: 30
required:
- fromTime
- toTime
example:
fromTime:
hour: 9
minute: 0
toTime:
hour: 17
minute: 0
description: Active time ranges for this day
required:
- weekDay
- isActive
example:
weekDay: Monday
isActive: true
timeRanges:
- fromTime:
hour: 9
minute: 0
toTime:
hour: 17
minute: 0
description: >-
Follow-up schedule timings (used when
useFollowUpSchedule is true)
isDefault:
type: boolean
description: Whether this is the default schedule
readOnly: true
status:
type: string
description: Current status of the schedule
readOnly: true
example:
id: 1
name: Business hours
timezoneId: America/New_York
excludeHolidays: true
useProspectTimezone: false
useFollowUpSchedule: false
mainTimings:
- weekDay: Monday
isActive: true
timeRanges:
- fromTime:
hour: 9
minute: 0
toTime:
hour: 17
minute: 0
followUpTimings: []
isDefault: true
status: active
'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 required feature scope to view schedules
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: Feature scopes [ViewScheduler] are denied for userId 123
code: schedule.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**.
````