> ## 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. # Schemas > Object models used across the Reply API v3, grouped by resource domain. 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](/api-reference/schemas/contact-account-filter-item) | A single filter condition for contact account queries | | [Contact](/api-reference/schemas/contact) | Contact response model | | [Contact Account](/api-reference/schemas/contact-account) | A contact account representing a company or organization | | [Contact Account Contact](/api-reference/schemas/contact-account-contact) | A contact linked to a contact account | | [Contact Account Details](/api-reference/schemas/contact-account-details) | A single contact account, including the resolved email provider | | [Contact Account List](/api-reference/schemas/contact-account-list) | Account list entity | | [Contact Account Stage](/api-reference/schemas/contact-account-stage) | Stage assigned to a contact account | | [Contact List](/api-reference/schemas/contact-list) | Contact list entity | | [Contact List Reference](/api-reference/schemas/contact-list-ref) | Lightweight contact list reference | ## Sequences | Schema | Description | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | [AI SDR sequence settings](/api-reference/schemas/sequence) | AI SDR-specific settings of a sequence. | | [Sequence](/api-reference/schemas/sequence-response) | Full representation of a sequence, including its schedule and the email and LinkedIn accounts used to send from it. | | [Sequence Contact](/api-reference/schemas/sequence-contact-item) | A contact enrolled in a sequence with sequence-specific metadata | | [Sequence Contacts List](/api-reference/schemas/sequence-contact) | Response model for listing contacts in a sequence with pagination | | [Sequence Contacts List with Extended State](/api-reference/schemas/sequence-contact-state) | Response model for listing contacts in a sequence with pagination, including extended state columns | | [Sequence Email Account](/api-reference/schemas/sequence-email-account) | An email account linked to a sequence for sending outbound emails. | | [Sequence Folder](/api-reference/schemas/sequence-folder) | A folder for organizing sequences | | [Sequence LinkedIn Account](/api-reference/schemas/sequence-linkedin-account) | A LinkedIn account linked to a sequence | | [Sequence Step Info](/api-reference/schemas/sequence-step-info) | Position of the contact within a sequence's step graph. | | [Sequence Template](/api-reference/schemas/sequence-template-base) | A sequence template | | [Sequence Templates List](/api-reference/schemas/sequence-templates-list) | Response model for listing sequence templates grouped by scope | | [Step Variant](/api-reference/schemas/variant) | A text variant for a sequence step | ## Email accounts | Schema | Description | | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | [Email Account Detail](/api-reference/schemas/email-account-detail) | Full detailed representation of an email account, including all configuration sections. | | [Email Account Tag](/api-reference/schemas/email-account-tag) | An email account tag used for organizing and filtering accounts. | ## Email templates | Schema | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------- | | [Email Template](/api-reference/schemas/email-template) | Full representation of an email template including timestamps. | | [Email Template Attachment](/api-reference/schemas/email-template-attachment) | Attachment associated with an email template. | | [Email Template Folder](/api-reference/schemas/email-template-folder) | An email template folder for organizing templates. | | [Email Template Variables](/api-reference/schemas/email-template-variables) | Available template variables grouped by category. | | [Render Error](/api-reference/schemas/email-template-render-error) | An error encountered during template rendering. | | [Render Template Result](/api-reference/schemas/email-template-render-result) | Result of rendering an email template with variable substitution. | | [Variable Info](/api-reference/schemas/email-template-variable-info) | Information about a single template variable. | ## Inbox | Schema | Description | | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | [Inbox Category](/api-reference/schemas/category) | Inbox thread category. | | [Inbox Thread](/api-reference/schemas/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](/api-reference/schemas/thread-ai-draft) | The thread's pending AI-drafted reply, awaiting review. | | [Inbox Thread Category Reference](/api-reference/schemas/thread-category) | Minimal category reference embedded in thread responses. | | [Inbox Thread Contact](/api-reference/schemas/thread-contact) | Contact party on the other end of an inbox thread. | | [Inbox Thread Message Status](/api-reference/schemas/thread-message-status) | Per-message status. | | [Inbox Thread Sequence](/api-reference/schemas/thread-sequence) | Minimal sequence reference attached to an inbox thread. | | [Inbox Thread Status](/api-reference/schemas/thread-status) | Aggregated thread state, derived from the latest message. | ## Tasks | Schema | Description | | -------------------------------------------- | --------------------------------------------------------------------- | | [Task](/api-reference/schemas/task-response) | Full task detail returned by GET by ID, Create, and Update endpoints. | ## LinkedIn | Schema | Description | | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | [Connection Link](/api-reference/schemas/connection-link) | A link for connecting a LinkedIn account via browser extension. | | [Connection Link With Pending](/api-reference/schemas/connection-link-with-pending) | A connection link with the associated pending account ID. | | [LinkedIn Account](/api-reference/schemas/linkedin-account) | Full representation of a LinkedIn account. | | [LinkedIn Account Limits](/api-reference/schemas/linkedin-account-limits) | Daily limits configuration for a LinkedIn account. | | [LinkedIn Account Limits Values](/api-reference/schemas/linkedin-account-limits-values) | Individual daily limit values for LinkedIn automation actions. | | [LinkedIn Account Revoke Settings](/api-reference/schemas/linkedin-account-revoke-settings) | Connection revocation settings for a LinkedIn account. | | [LinkedIn Account Toggle Status](/api-reference/schemas/linkedin-account-toggle-status) | Response after toggling a LinkedIn account status. | | [LinkedIn Account Usage](/api-reference/schemas/linkedin-account-usage) | Daily usage statistics for a LinkedIn account. | | [LinkedIn Account Voice Profile](/api-reference/schemas/linkedin-account-voice-profile) | Voice profile associated with a LinkedIn account. | | [LinkedIn Action Item](/api-reference/schemas/linkedin-action-item) | Individual LinkedIn action record in a reporting list | | [Pending LinkedIn Account](/api-reference/schemas/pending-linkedin-account) | A LinkedIn account that is pending connection. | ## Schedules & holidays | Schema | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | [Holiday](/api-reference/schemas/holiday) | A single holiday entry within a calendar. | | [Holiday Calendar](/api-reference/schemas/holiday-calendar) | Full representation of a holiday calendar including individual holidays. | | [Holiday Input](/api-reference/schemas/holiday-input) | A holiday entry for creating or updating a calendar. | | [Schedule](/api-reference/schemas/schedule) | Full representation of a schedule with timing configuration. | | [Schedule Time](/api-reference/schemas/schedule-time) | A time of day represented as hour and minute. | | [Schedule Timing](/api-reference/schemas/schedule-timing) | Timing configuration for a single day of the week. | | [Schedule Timing Time Range](/api-reference/schemas/schedule-timing-time-range) | A time range within a day. | ## Blocklist rules | Schema | Description | | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | [Domain Blacklist Rule](/api-reference/schemas/domain-rule) | A blacklist rule that blocks a domain pattern | | [Email Blacklist Rule](/api-reference/schemas/email-rule) | A blacklist rule that blocks an email pattern | | [Email Exception Blacklist Rule](/api-reference/schemas/email-exception-rule) | An exception rule that allows an email pattern even if it matches a blacklist rule | ## AI SDR | Schema | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | [Knowledge Base](/api-reference/schemas/knowledge-base) | Detailed representation of a knowledge base. | | [Knowledge Base Document](/api-reference/schemas/knowledge-base-document) | A file document attached to a knowledge base. | | [Knowledge Base Link](/api-reference/schemas/knowledge-base-link) | A web link attached to a knowledge base. | | [Knowledge Base Media](/api-reference/schemas/knowledge-base-media) | A media file attached to a reply handler or reengagement card. | | [Offer](/api-reference/schemas/offer) | Detailed representation of an offer — the bundle of company-context inputs the AI SDR uses to personalize outreach. | | [Playbook](/api-reference/schemas/playbook) | Detailed representation of a playbook, returned by get/create/update responses. | | [Playbook Style File](/api-reference/schemas/playbook-style-file) | A single style file attached to a playbook. | | [Reengagement Card](/api-reference/schemas/reengagement-card) | Detailed representation of a reengagement card. | | [Reply Handler](/api-reference/schemas/reply-handler) | Detailed representation of a reply handler. | ## Reports & analytics | Schema | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | [Calls Overview Response](/api-reference/schemas/calls-overview-response) | Aggregated call statistics with per-member breakdown | | [Channel Efficiency Overview Response](/api-reference/schemas/channel-efficiency-overview-response) | Cross-channel efficiency statistics | | [Emails Overview Response](/api-reference/schemas/emails-overview-response) | Email delivery and engagement metrics | | [LinkedIn Overview Response](/api-reference/schemas/linkedin-overview-response) | LinkedIn engagement metrics overview | | [Sequence Stats Response](/api-reference/schemas/sequence-stats-response) | Aggregated email and LinkedIn stats for a single sequence | | [Tasks Overview Response](/api-reference/schemas/tasks-overview-response) | Aggregated task statistics broken down by type, with per-member breakdown | | [Team Performance Overview Response](/api-reference/schemas/team-performance-overview-response) | Team performance metrics including meetings, contacts, and engagement rates | ## Live data | Schema | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | | [Live Data search](/api-reference/schemas/search) | Summary of a Live Data search. | | [Live Data search details](/api-reference/schemas/search-details) | A single Live Data search, including the filters it was run with. | ## Attachments | Schema | Description | | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | [Attachment](/api-reference/schemas/attachment) | Uploaded file attachment usable across email templates, sequence steps, and direct emails. | | [Voice Attachment](/api-reference/schemas/voice-attachment) | Uploaded voice message attachment. | ## Background jobs | Schema | Description | | ------------------------------------------------------- | ------------------------------------------------------- | | [Background Job](/api-reference/schemas/background-job) | A long-running background operation tracked by the API. | ## Webhooks | Schema | Description | | ------------------------------------------------------- | -------------------------------------------------------------------- | | [Webhook](/api-reference/schemas/webhook) | A webhook subscription. | | [Webhook Events](/api-reference/schemas/webhook-events) | Catalog of event types that a webhook subscription can subscribe to. | | [Webhook Log](/api-reference/schemas/webhook-log) | One delivery-attempt record for a webhook subscription. | ## Common | Schema | Description | | ----------------------------------------------------------------------------- | ------------------------------------------------------ | | [Create Item Result](/api-reference/schemas/create-item-result) | Per-item result for non-atomic bulk create operations. | | [Not Processed Item Result](/api-reference/schemas/not-processed-item-result) | Per-item error for non-atomic bulk operations. | | [Validation Error](/api-reference/schemas/validation-error) | A single field-level validation error. | | [Validation Problem](/api-reference/schemas/validation-problem) | Input-validation error response at 400. | ## Other | Schema | Description | | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | [Business Problem](/api-reference/schemas/business-problem) | Domain error response carrying a stable, namespaced error slug. | | [Count Result](/api-reference/schemas/count-result) | | | [Custom Field](/api-reference/schemas/custom-field) | A user-defined field for storing additional data on contacts. | | [Email Validation Estimate](/api-reference/schemas/email-validation-estimate-response) | Synchronous probe result returned by `/v3/email-validations/estimate`. | | [Email Validation Schedule](/api-reference/schemas/email-validation-schedule-response) | Acknowledgement returned by `/v3/email-validations/schedule`. | | [Intent Signal Industry](/api-reference/schemas/intent-industry-item) | A single industry entry from the typeahead list, used in intent-signal configuration. | | [Intent Signal Technology](/api-reference/schemas/intent-technology-item) | A single technology entry from the typeahead list, used in intent-signal configuration. | | [Problem Details](/api-reference/schemas/problem-details) | Bare RFC 9457 problem-details envelope. | | [Settings](/api-reference/schemas/settings) | Team and user settings. |