Schemas - Reply API Documentation

Reference for the objects the Reply API v3 accepts and returns. Each entry links to a dedicated page with the full field list, types, and descriptions.

Contacts & lists

Schema	Description
Account Filter Item	A single filter condition for contact account queries
Contact	Contact response model
Contact Account	A contact account representing a company or organization
Contact Account Contact	A contact linked to a contact account
Contact Account Details	A single contact account, including the resolved email provider
Contact Account List	Account list entity
Contact Account Stage	Stage assigned to a contact account
Contact Inbox Thread	Inbox thread summary as it appears on a single contact’s timeline.
Contact List	Contact list entity
Contact List Reference	Lightweight contact list reference

Sequences

Schema	Description
AI SDR sequence settings	AI SDR-specific settings of a sequence.
Sequence	Full representation of a sequence, including its schedule and the email and LinkedIn accounts used to send from it.
Sequence Contact	A contact enrolled in a sequence with sequence-specific metadata
Sequence Contacts List	Response model for listing contacts in a sequence with pagination
Sequence Contacts List with Extended State	Response model for listing contacts in a sequence with pagination, including extended state columns
Sequence Email Account	An email account linked to a sequence for sending outbound emails.
Sequence Folder	A folder for organizing sequences
Sequence LinkedIn Account	A LinkedIn account linked to a sequence
Sequence Step Info	Position of the contact within a sequence’s step graph.
Sequence Template	A sequence template
Sequence Templates List	Response model for listing sequence templates grouped by scope
Step Variant	A text variant for a sequence step

Email accounts

Schema	Description
Email Account Detail	Full detailed representation of an email account, including all configuration sections.
Email Account Stats
Email Account Tag	An email account tag used for organizing and filtering accounts.

Email templates

Schema	Description
Email Template	Full representation of an email template including timestamps.
Email Template Attachment	Attachment associated with an email template.
Email Template Folder	An email template folder for organizing templates.
Email Template Variables	Available template variables grouped by category.
Render Error	An error encountered during template rendering.
Render Template Result	Result of rendering an email template with variable substitution.
Variable Info	Information about a single template variable.

Inbox

Schema	Description
Inbox Category	Inbox thread category.
Inbox Thread	Full inbox thread with the contact, channel-specific account ids, sequence, category, meeting-intent flag, and the ordered list of messages.
Inbox Thread AI Draft	The thread’s pending AI-drafted reply, awaiting review.
Inbox Thread Category Reference	Minimal category reference embedded in thread responses.
Inbox Thread Contact	Contact party on the other end of an inbox thread.
Inbox Thread Message Status	Per-message status.
Inbox Thread Sequence	Minimal sequence reference attached to an inbox thread.
Inbox Thread Status	Aggregated thread state, derived from the latest message.

Tasks

Schema	Description
Task	Full task detail returned by GET by ID, Create, and Update endpoints.

LinkedIn

Schema	Description
Connection Link	A link for connecting a LinkedIn account via browser extension.
Connection Link With Pending	A connection link with the associated pending account ID.
LinkedIn Account	Full representation of a LinkedIn account.
LinkedIn Account Limits	Daily limits configuration for a LinkedIn account.
LinkedIn Account Limits Values	Individual daily limit values for LinkedIn automation actions.
LinkedIn Account Revoke Settings	Connection revocation settings for a LinkedIn account.
LinkedIn Account Toggle Status	Response after toggling a LinkedIn account status.
LinkedIn Account Usage	Daily usage statistics for a LinkedIn account.
LinkedIn Account Voice Profile	Voice profile associated with a LinkedIn account.
LinkedIn Action Item	Individual LinkedIn action record in a reporting list
Pending LinkedIn Account	A LinkedIn account that is pending connection.

Schedules & holidays

Schema	Description
Holiday	A single holiday entry within a calendar.
Holiday Calendar	Full representation of a holiday calendar including individual holidays.
Holiday Input	A holiday entry for creating or updating a calendar.
Schedule	Full representation of a schedule with timing configuration.
Schedule Time	A time of day represented as hour and minute.
Schedule Timing	Timing configuration for a single day of the week.
Schedule Timing Time Range	A time range within a day.

Blocklist rules

Schema	Description
Domain Blacklist Rule	A blacklist rule that blocks a domain pattern
Email Blacklist Rule	A blacklist rule that blocks an email pattern
Email Exception Blacklist Rule	An exception rule that allows an email pattern even if it matches a blacklist rule

AI SDR

Schema	Description
Knowledge Base	Detailed representation of a knowledge base.
Knowledge Base Document	A file document attached to a knowledge base.
Knowledge Base Link	A web link attached to a knowledge base.
Knowledge Base Media	A media file attached to a reply handler or reengagement card.
Offer	Detailed representation of an offer — the bundle of company-context inputs the AI SDR uses to personalize outreach.
Playbook	Detailed representation of a playbook, returned by get/create/update responses.
Playbook Style File	A single style file attached to a playbook.
Reengagement Card	Detailed representation of a reengagement card.
Reply Handler	Detailed representation of a reply handler.

Reports & analytics

Schema	Description
Calls Overview Response	Aggregated call statistics with per-member breakdown
Channel Efficiency Overview Response	Cross-channel efficiency statistics
Emails Overview Response	Email delivery and engagement metrics
LinkedIn Overview Response	LinkedIn engagement metrics overview
Sequence Stats Response	Aggregated email and LinkedIn stats for a single sequence
Tasks Overview Response	Aggregated task statistics broken down by type, with per-member breakdown
Team Performance Overview Response	Team performance metrics including meetings, contacts, and engagement rates

Live data

Schema	Description
Live Data search	Summary of a Live Data search.
Live Data search details	A single Live Data search, including the filters it was run with.

Attachments

Schema	Description
Attachment	Uploaded file attachment usable across email templates, sequence steps, and direct emails.
Voice Attachment	Uploaded voice message attachment.

Background jobs

Schema	Description
Background Job	A long-running background operation tracked by the API.

Webhooks

Schema	Description
Webhook	A webhook subscription.
Webhook events schema	Catalog of event types that a webhook subscription can subscribe to.
Webhook Log	One delivery-attempt record for a webhook subscription.

Common

Schema	Description
Create Item Result	Per-item result for non-atomic bulk create operations.
Not Processed Item Result	Per-item error for non-atomic bulk operations.
Validation Error	A single field-level validation error.
Validation Problem	Input-validation error response at 400.

Other

Schema	Description
AI Prompt	An AI prompt available for configuring a sequence step.
Business Problem	Domain error response carrying a stable, namespaced error slug.
Count Result
Custom Field	A user-defined field for storing additional data on contacts.
Email Validation Estimate	Synchronous probe result returned by `/v3/email-validations/estimate`.
Email Validation Schedule	Acknowledgement returned by `/v3/email-validations/schedule`.
Intent Signal Industry	A single industry entry from the typeahead list, used in intent-signal configuration.
Intent Signal Technology	A single technology entry from the typeahead list, used in intent-signal configuration.
Problem Details	Bare RFC 9457 problem-details envelope.
Reengagement Flow
Reengagement Flow State
Settings	Team and user settings.