# Reply API Documentation

- [3.0 (412 pages)](https://docs.reply.io/_llms/3-0.md): Documentation for 3.0.

## Other

- [AI Prompt](https://docs.reply.io/api-reference/schemas/ai-prompt.md): An AI prompt you can attach to a sequence step. Returns the id, name, prompt text, scope, and the step type it applies to.
- [Attachment](https://docs.reply.io/api-reference/schemas/attachment.md): An uploaded file you can attach to email templates, sequence steps, and direct emails in Reply. Returns the id, file name, and size.
- [Available Domain](https://docs.reply.io/api-reference/schemas/available-domain.md): A domain name offered for purchase, with its first-term and renewal prices in cents.
- [Background Job](https://docs.reply.io/api-reference/schemas/background-job.md): A long-running job tracked by the Reply API. Returns status, progress, timing, and the raw input and result payloads.
- [Business Problem](https://docs.reply.io/api-reference/schemas/business-problem.md): The error object Reply returns for most 4xx responses. Carries a stable, namespaced error slug you can branch on in code.
- [Calls Overview Response](https://docs.reply.io/api-reference/schemas/calls-overview-response.md): Aggregated call stats from Reply reporting: total calls, average duration, answered and positive calls, plus a per-member breakdown.
- [Inbox Category](https://docs.reply.io/api-reference/schemas/category.md): An inbox thread category in Reply. Reserved categories belong to the system and cannot be edited or deleted through the API.
- [Channel Efficiency Overview Response](https://docs.reply.io/api-reference/schemas/channel-efficiency-overview-response.md): Cross-channel efficiency stats in Reply: people contacted, total touches, replies, and meetings booked, with percentages.
- [Connection Link](https://docs.reply.io/api-reference/schemas/connection-link.md): The one-field response holding the link you use to connect a LinkedIn account through the Reply browser extension.
- [Connection Link With Pending](https://docs.reply.io/api-reference/schemas/connection-link-with-pending.md): A LinkedIn connection link plus the id of the pending account it creates, so you can track the connection while it finishes.
- [Contact](https://docs.reply.io/api-reference/schemas/contact.md): The Contact object returned by the Reply API. Includes email, name, phone, job title, company, location, time zone, and custom fields.
- [Contact Account](https://docs.reply.io/api-reference/schemas/contact-account.md): The Contact Account object, which represents a company in Reply. Returns the name, domain, industry, size, location, and owner.
- [Contact Account Contact](https://docs.reply.io/api-reference/schemas/contact-account-contact.md): A contact linked to a company account in Reply. Returns the id, email, first and last name, job title, and company.
- [Contact Account Details](https://docs.reply.io/api-reference/schemas/contact-account-details.md): A single contact account in Reply with full detail, including the resolved email provider for the company's domain.
- [Account Filter Item](https://docs.reply.io/api-reference/schemas/contact-account-filter-item.md): One filter condition used when querying contact accounts in Reply. Made up of a property, a condition, and a set of values.
- [Contact Account List](https://docs.reply.io/api-reference/schemas/contact-account-list.md): An account list in Reply, used to group company records together. Returns the list id and the list name.
- [Contact Account Stage](https://docs.reply.io/api-reference/schemas/contact-account-stage.md): The stage assigned to a contact account in Reply. Returns the stage id, its name, and the color id used to display it in the app.
- [Contact Inbox Thread](https://docs.reply.io/api-reference/schemas/contact-inbox-thread.md): An inbox thread as it appears on a single contact's timeline in Reply. A trimmed view with no message history or body preview.
- [Contact List](https://docs.reply.io/api-reference/schemas/contact-list.md): The Contact List object in the Reply API. Three fields: the list id, its name, and whether the list is shared with your team.
- [Contact List Reference](https://docs.reply.io/api-reference/schemas/contact-list-ref.md): A lightweight contact list reference used inside other Reply API responses. Carries just the list id and name, not the full record.
- [Count Result](https://docs.reply.io/api-reference/schemas/count-result.md): A simple response object with a single field, count, used by Reply endpoints that only need to return a total.
- [Create Item Result](https://docs.reply.io/api-reference/schemas/create-item-result.md): The per-item result for bulk create calls in Reply. Successful items return an id; failed ones return an error code and details.
- [Custom Field](https://docs.reply.io/api-reference/schemas/custom-field.md): A custom field you define to store extra data on Reply contacts. Returns the title, the field type, and whether it is org-wide.
- [Domain Blacklist Rule](https://docs.reply.io/api-reference/schemas/domain-rule.md): A blacklist rule that blocks a whole domain in Reply. Returns the pattern and whether the rule applies across the organization.
- [Email Account Detail](https://docs.reply.io/api-reference/schemas/email-account-detail.md): The full email account object in Reply, with connection status, sending safety limits, signature, and opt-out configuration.
- [Email Account Stats](https://docs.reply.io/api-reference/schemas/email-account-stats.md): Sending stats for one email account in Reply: emails sent today, total emails sent, and the current daily sending limit.
- [Email Account Tag](https://docs.reply.io/api-reference/schemas/email-account-tag.md): A tag used to organize and filter email accounts in Reply. Returns the tag id, its name, and the color id for display.
- [Email Exception Blacklist Rule](https://docs.reply.io/api-reference/schemas/email-exception-rule.md): An exception rule that lets an email address through even when it matches one of your Reply blacklist rules. Returns the id and pattern.
- [Email Blacklist Rule](https://docs.reply.io/api-reference/schemas/email-rule.md): A blacklist rule that blocks a specific email pattern in Reply, plus whether it applies across the whole organization.
- [Email Template](https://docs.reply.io/api-reference/schemas/email-template.md): The Email Template object in the Reply API. Returns the subject, body, folder, attachments, and the created and updated timestamps.
- [Email Template Attachment](https://docs.reply.io/api-reference/schemas/email-template-attachment.md): A file attached to a Reply email template. Returns the attachment id, the file name, the download URL, and the size.
- [Email Template Folder](https://docs.reply.io/api-reference/schemas/email-template-folder.md): A folder used to organize email templates in Reply. Returns the folder id, its name, the folder type, and whether it is the default.
- [Render Error](https://docs.reply.io/api-reference/schemas/email-template-render-error.md): An error hit while rendering a Reply email template. Returns the error code, a message, and the variable that caused it.
- [Render Template Result](https://docs.reply.io/api-reference/schemas/email-template-render-result.md): The result of rendering a Reply email template with variables filled in. Returns the subject, the body, and any render errors.
- [Variable Info](https://docs.reply.io/api-reference/schemas/email-template-variable-info.md): Details about a single Reply email template variable: the key you type into a template and what that key stands for.
- [Email Template Variables](https://docs.reply.io/api-reference/schemas/email-template-variables.md): The template variables you can use in Reply emails, grouped into three categories: prospect, team, and advanced.
- [Email Validation Estimate](https://docs.reply.io/api-reference/schemas/email-validation-estimate-response.md): The estimate Reply returns before you run email validation. Shows eligible contacts, credits needed, and anything blocking the job.
- [Email Validation Schedule](https://docs.reply.io/api-reference/schemas/email-validation-schedule-response.md): The acknowledgement Reply returns after you schedule email validation. Use the jobId to poll the background job for progress.
- [Emails Overview Response](https://docs.reply.io/api-reference/schemas/emails-overview-response.md): Email delivery and engagement metrics in Reply: delivered, opened, replied, bounced, opted out, and meetings booked.
- [Estimate Seats](https://docs.reply.io/api-reference/schemas/estimate-seats.md): Paid-seat counts and unit price for one seat type in an order estimate.
- [Holiday](https://docs.reply.io/api-reference/schemas/holiday.md): A single holiday inside a Reply holiday calendar. Returns the id, the start and end dates, and the name of the holiday.
- [Holiday Calendar](https://docs.reply.io/api-reference/schemas/holiday-calendar.md): A holiday calendar in Reply, listing each holiday plus the country, the calendar type, and whether it repeats every year.
- [Holiday Input](https://docs.reply.io/api-reference/schemas/holiday-input.md): The holiday entry you send when creating or updating a Reply holiday calendar. Takes a start date, an end date, and a name.
- [Intent Signal Industry](https://docs.reply.io/api-reference/schemas/intent-industry-item.md): One industry from the Reply typeahead list used to configure AI SDR intent signals. Returns the industry id and its name.
- [Intent Signal Technology](https://docs.reply.io/api-reference/schemas/intent-technology-item.md): One technology from the Reply typeahead list used to set up AI SDR intent signals. Returns the slug you save and the display name.
- [Knowledge Base](https://docs.reply.io/api-reference/schemas/knowledge-base.md): An AI SDR knowledge base in Reply. Returns the name, the instructions that guide replies, the owner, and the last update time.
- [Knowledge Base Document](https://docs.reply.io/api-reference/schemas/knowledge-base-document.md): A file attached to an AI SDR knowledge base in Reply. Returns the document id, the file name, and when it was added.
- [Knowledge Base Link](https://docs.reply.io/api-reference/schemas/knowledge-base-link.md): A web link attached to an AI SDR knowledge base in Reply. Returns the link id, the URL, and when it was added.
- [Knowledge Base Media](https://docs.reply.io/api-reference/schemas/knowledge-base-media.md): A media file attached to a reply handler or a reengagement card in Reply. Returns the id, the file name, and the size.
- [LinkedIn Account](https://docs.reply.io/api-reference/schemas/linkedin-account.md): The full LinkedIn account object in Reply: status, profile URL, account and auth type, cookie status, usage, limits, and voice profile.
- [LinkedIn Account Limits](https://docs.reply.io/api-reference/schemas/linkedin-account-limits.md): How daily LinkedIn limits are set for an account in Reply, either a fixed maximum or a random range between two values.
- [LinkedIn Account Limits Values](https://docs.reply.io/api-reference/schemas/linkedin-account-limits-values.md): The daily caps for LinkedIn actions in Reply: connection requests, messages, InMails, profile views, likes, and more.
- [LinkedIn Account Revoke Settings](https://docs.reply.io/api-reference/schemas/linkedin-account-revoke-settings.md): Settings that control when Reply withdraws unanswered LinkedIn connection requests. Returns whether it is on and the wait in days.
- [LinkedIn Account Toggle Status](https://docs.reply.io/api-reference/schemas/linkedin-account-toggle-status.md): The response Reply returns after you turn a LinkedIn account on or off. Contains the account's new status.
- [LinkedIn Account Usage](https://docs.reply.io/api-reference/schemas/linkedin-account-usage.md): Today's LinkedIn usage for an account in Reply: connection requests, messages, InMails, profile views, likes, and more.
- [LinkedIn Account Voice Profile](https://docs.reply.io/api-reference/schemas/linkedin-account-voice-profile.md): The voice profile tied to a LinkedIn account in Reply. Returns the profile id, its name, and whether it is the default profile.
- [LinkedIn Action Item](https://docs.reply.io/api-reference/schemas/linkedin-action-item.md): One LinkedIn action in a Reply reporting list. Shows the contact, the sender account, the sequence step, the action type, and the date.
- [LinkedIn Overview Response](https://docs.reply.io/api-reference/schemas/linkedin-overview-response.md): LinkedIn engagement metrics in Reply: connections sent and accepted, messages, InMails, replies, profile views, and likes.
- [Not Processed Item Result](https://docs.reply.io/api-reference/schemas/not-processed-item-result.md): The per-item error returned by bulk operations in Reply. Only failed items appear; anything missing from the list succeeded.
- [Offer](https://docs.reply.io/api-reference/schemas/offer.md): The Offer object holds the company details your AI SDR uses to personalize outreach: ICP, pain points, proof points, and calls to action.
- [Pending LinkedIn Account](https://docs.reply.io/api-reference/schemas/pending-linkedin-account.md): A LinkedIn account waiting to finish connecting to Reply. Returns the connection link, when it expires, and whether it already has.
- [Playbook](https://docs.reply.io/api-reference/schemas/playbook.md): The Playbook object your AI SDR follows in Reply. Returns the name, description, body text, type, author, and style files.
- [Playbook Style File](https://docs.reply.io/api-reference/schemas/playbook-style-file.md): A reference document attached to a Reply playbook. Style files shape the tone and voice the AI SDR writes in.
- [Problem Details](https://docs.reply.io/api-reference/schemas/problem-details.md): The base error object the Reply API returns for 401, 429, and route-level 404 responses. Holds a title, an HTTP status, and a detail message.
- [Reengagement Card](https://docs.reply.io/api-reference/schemas/reengagement-card.md): The Reengagement Card your AI SDR sends after a set delay. Holds instructions, tone, length, links, media, and send timing.
- [Reengagement Flow](https://docs.reply.io/api-reference/schemas/reengagement-flow.md): A reengagement flow in an AI SDR knowledge base — an alternative follow-up track. Returns its name, card count, and default flag.
- [Reengagement Flow State](https://docs.reply.io/api-reference/schemas/reengagement-flow-state.md): Which reengagement flow a contact is currently on. Two fields: the flow id and when it was assigned to them.
- [Reply Handler](https://docs.reply.io/api-reference/schemas/reply-handler.md): The Reply Handler object your AI SDR uses to answer one type of question. Holds instructions, tone, length, links, and media.
- [Schedule](https://docs.reply.io/api-reference/schemas/schedule.md): A sending schedule in Reply, with the time zone, daily sending windows, follow-up timings, and holiday exclusion settings.
- [Schedule Time](https://docs.reply.io/api-reference/schemas/schedule-time.md): A time of day used inside Reply schedules. Stored as two simple fields: the hour and the minute, both as integers.
- [Schedule Timing](https://docs.reply.io/api-reference/schemas/schedule-timing.md): The timing setup for one day of the week in a Reply schedule: the day, whether it is active, and its time ranges.
- [Schedule Timing Time Range](https://docs.reply.io/api-reference/schemas/schedule-timing-time-range.md): A sending window inside a Reply schedule, defined by a start time and an end time.
- [Live Data search](https://docs.reply.io/api-reference/schemas/search.md): A summary of one Live Data search in Reply: its status, start time, contacts found, credits used, and the lists it filled.
- [Live Data search details](https://docs.reply.io/api-reference/schemas/search-details.md): A single Live Data search in Reply, returned together with the full set of filters it was run with.
- [AI SDR sequence settings](https://docs.reply.io/api-reference/schemas/sequence.md): The AI SDR settings on a Reply sequence: offer, tone of voice, playbook, knowledge base, autopilot, and intent signals.
- [Sequence Contacts List](https://docs.reply.io/api-reference/schemas/sequence-contact.md): The paginated response for listing contacts in a Reply sequence. Returns an items array plus a hasMore flag for the next page.
- [Sequence Contact](https://docs.reply.io/api-reference/schemas/sequence-contact-item.md): A contact enrolled in a Reply sequence, with sequence data: current step, status, opt-out flag, and call and meeting status.
- [Sequence Contacts List with Extended State](https://docs.reply.io/api-reference/schemas/sequence-contact-state.md): The paginated response for listing contacts in a Reply sequence, with the extended state columns included.
- [Sequence Email Account](https://docs.reply.io/api-reference/schemas/sequence-email-account.md): An email account attached to a Reply sequence for sending. Returns the address, sender name, daily limit, and connection status.
- [Sequence Folder](https://docs.reply.io/api-reference/schemas/sequence-folder.md): A folder used to organize sequences in Reply. Returns just two fields: the folder id and the folder name.
- [Sequence LinkedIn Account](https://docs.reply.io/api-reference/schemas/sequence-linkedin-account.md): A LinkedIn account attached to a Reply sequence. Returns the account id, its name, the profile URL, and the connection status.
- [Sequence](https://docs.reply.io/api-reference/schemas/sequence-response.md): The full Sequence object in the Reply API, including its schedule and the email and LinkedIn accounts it sends from.
- [Sequence Stats Response](https://docs.reply.io/api-reference/schemas/sequence-stats-response.md): Combined email and LinkedIn stats for a single Reply sequence, returned as two separate overview objects.
- [Sequence Step Info](https://docs.reply.io/api-reference/schemas/sequence-step-info.md): Where a contact currently sits in a Reply sequence. Returns the step id and a readable label, or Finished when they are done.
- [Sequence Template](https://docs.reply.io/api-reference/schemas/sequence-template-base.md): A sequence template in Reply. Returns the name, description, the step types it uses, and whether it has conditional steps.
- [Sequence Templates List](https://docs.reply.io/api-reference/schemas/sequence-templates-list.md): Reply sequence templates grouped by scope: global templates, organization templates, and team templates.
- [Settings](https://docs.reply.io/api-reference/schemas/settings.md): Team and user settings in Reply, covering account, email, LinkedIn, calls, contacts, and beta options. Every field can be null.
- [Task](https://docs.reply.io/api-reference/schemas/task-response.md): The Task object the Reply API returns when you get, create, or update a task. Lists every field, including status, owner, and due dates.
- [Tasks Overview Response](https://docs.reply.io/api-reference/schemas/tasks-overview-response.md): Task stats from Reply reporting, broken down by type: calls, emails, LinkedIn, SMS, WhatsApp, to-dos, and meetings booked.
- [Team Performance Overview Response](https://docs.reply.io/api-reference/schemas/team-performance-overview-response.md): Team performance metrics from Reply reporting: meetings booked, contacts reached, touches per contact, and average response time.
- [Inbox Thread](https://docs.reply.io/api-reference/schemas/thread.md): The full Reply inbox thread: the contact, channel, sequence, category, meeting-intent flag, and every message in order.
- [Inbox Thread AI Draft](https://docs.reply.io/api-reference/schemas/thread-ai-draft.md): The AI-written reply waiting for your review on a Reply inbox thread. A thread has at most one active AI draft.
- [Inbox Thread Category Reference](https://docs.reply.io/api-reference/schemas/thread-category.md): A small category reference embedded in Reply inbox thread responses. Carries only the category id and its name.
- [Inbox Thread Contact](https://docs.reply.io/api-reference/schemas/thread-contact.md): The contact on the other side of a Reply inbox thread. Covers both live contacts and deleted ones, which come back with null id fields.
- [Inbox Thread Message Status](https://docs.reply.io/api-reference/schemas/thread-message-status.md): The delivery status of one message in a Reply thread. Only filled in for outbound messages that hit a delivery error.
- [Inbox Thread Sequence](https://docs.reply.io/api-reference/schemas/thread-sequence.md): A minimal sequence reference attached to a Reply inbox thread. Holds just the sequence id and the sequence name.
- [Inbox Thread Status](https://docs.reply.io/api-reference/schemas/thread-status.md): The overall state of a Reply inbox thread, worked out from the most recent message in that thread.
- [Validation Error](https://docs.reply.io/api-reference/schemas/validation-error.md): A single field-level validation error from the Reply API. Points at the field that failed and explains what went wrong.
- [Validation Problem](https://docs.reply.io/api-reference/schemas/validation-problem.md): The 400 error the Reply API returns when a request fails validation. Route, query, and body errors all arrive in a single errors array.
- [Step Variant](https://docs.reply.io/api-reference/schemas/variant.md): A text variant for a Reply sequence step. Returns the subject, the message, whether it is enabled, and if it has attachments.
- [Voice Attachment](https://docs.reply.io/api-reference/schemas/voice-attachment.md): An uploaded voice message attachment in Reply. Returns the attachment id, the file name, and the length in seconds.
- [Webhook](https://docs.reply.io/api-reference/schemas/webhook.md): A webhook subscription in Reply. It sends one event type to your URL whenever matching activity happens inside the chosen scope.
- [Webhook events schema](https://docs.reply.io/api-reference/schemas/webhook-events.md): The catalog of event types a Reply webhook subscription can listen for, returned as a single events array.
- [Webhook Log](https://docs.reply.io/api-reference/schemas/webhook-log.md): One delivery attempt for a Reply webhook subscription. Returns the event id, the HTTP status your endpoint returned, and the time.
- [CLAUDE](https://docs.reply.io/CLAUDE.md)

## OpenAPI Specs

- [bundled](/api-reference/bundled.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [3.0 (412 pages)](https://docs.reply.io/_llms/3-0.md): Documentation for 3.0.
- [3.0 / API Reference (394 pages)](https://docs.reply.io/_llms/3-0/api-reference.md): Documentation for 3.0 / API Reference.