# FoxReach API

## Docs

- [Campaign Statistics](https://docs.foxreach.io/api-reference/analytics/campaign-stats.md): Retrieve detailed performance metrics for a specific campaign.
- [Workspace Overview](https://docs.foxreach.io/api-reference/analytics/overview.md): Retrieve workspace-wide analytics including accounts, campaigns, leads, and engagement metrics.
- [Add Accounts to Campaign](https://docs.foxreach.io/api-reference/campaigns/add-campaign-accounts.md): Assign email accounts to a campaign for sending and inbox rotation.
- [Add Leads to Campaign](https://docs.foxreach.io/api-reference/campaigns/add-campaign-leads.md): Add one or more leads to a campaign by their IDs.
- [Create Campaign](https://docs.foxreach.io/api-reference/campaigns/create-campaign.md): Create a new campaign in draft status.
- [Create Sequence Step](https://docs.foxreach.io/api-reference/campaigns/create-sequence.md): Add a new sequence step to a campaign. Campaign must be in draft or paused status.
- [Delete Campaign](https://docs.foxreach.io/api-reference/campaigns/delete-campaign.md): Delete a draft campaign. Only campaigns in draft status can be deleted.
- [Delete Sequence Step](https://docs.foxreach.io/api-reference/campaigns/delete-sequence.md): Delete a sequence step from a campaign. Campaign must be in draft or paused status.
- [Get Campaign](https://docs.foxreach.io/api-reference/campaigns/get-campaign.md): Retrieve a single campaign with its sequence steps.
- [List Campaign Accounts](https://docs.foxreach.io/api-reference/campaigns/list-campaign-accounts.md): Retrieve the email accounts assigned to a campaign for inbox rotation.
- [List Campaign Leads](https://docs.foxreach.io/api-reference/campaigns/list-campaign-leads.md): Retrieve a paginated list of leads enrolled in a campaign.
- [List Campaigns](https://docs.foxreach.io/api-reference/campaigns/list-campaigns.md): Retrieve a paginated list of campaigns in your workspace.
- [List Sequences](https://docs.foxreach.io/api-reference/campaigns/list-sequences.md): Retrieve all sequence steps for a campaign, ordered by step number.
- [Pause Campaign](https://docs.foxreach.io/api-reference/campaigns/pause-campaign.md): Pause an active campaign. No more emails will be sent until resumed.
- [Remove Account from Campaign](https://docs.foxreach.io/api-reference/campaigns/remove-campaign-account.md): Remove an email account from a campaign.
- [Remove Lead from Campaign](https://docs.foxreach.io/api-reference/campaigns/remove-campaign-lead.md): Remove a lead from a campaign. Campaign must not be active.
- [Resume Campaign](https://docs.foxreach.io/api-reference/campaigns/resume-campaign.md): Resume a paused campaign, transitioning it back to active.
- [Start Campaign](https://docs.foxreach.io/api-reference/campaigns/start-campaign.md): Start a campaign, transitioning it from draft or paused to active.
- [Update Campaign](https://docs.foxreach.io/api-reference/campaigns/update-campaign.md): Update campaign settings. Cannot edit while the campaign is active.
- [Update Sequence Step](https://docs.foxreach.io/api-reference/campaigns/update-sequence.md): Update a sequence step. Campaign must be in draft or paused status.
- [Delete Email Account](https://docs.foxreach.io/api-reference/email-accounts/delete-account.md): Delete an email account from your workspace.
- [Get Email Account](https://docs.foxreach.io/api-reference/email-accounts/get-account.md): Retrieve a single email account by ID.
- [List Email Accounts](https://docs.foxreach.io/api-reference/email-accounts/list-accounts.md): Retrieve a paginated list of email accounts in your workspace.
- [Delete Thread](https://docs.foxreach.io/api-reference/inbox/delete-thread.md): Delete a reply thread from the inbox.
- [Get Inbox Stats](https://docs.foxreach.io/api-reference/inbox/get-stats.md): Retrieve inbox statistics with counts by category.
- [Get Conversation](https://docs.foxreach.io/api-reference/inbox/get-thread.md): Retrieve the full conversation thread including all sent and received messages.
- [List Threads](https://docs.foxreach.io/api-reference/inbox/list-threads.md): Retrieve a paginated list of inbox reply threads.
- [Send Reply](https://docs.foxreach.io/api-reference/inbox/send-reply.md): Send a reply to an inbox thread.
- [Update Thread](https://docs.foxreach.io/api-reference/inbox/update-thread.md): Update a thread's read status, starred status, or category.
- [Create Lead](https://docs.foxreach.io/api-reference/leads/create-lead.md): Create a new lead in your workspace.
- [Delete Lead](https://docs.foxreach.io/api-reference/leads/delete-lead.md): Permanently delete a lead from your workspace.
- [Get Lead](https://docs.foxreach.io/api-reference/leads/get-lead.md): Retrieve a single lead by ID.
- [Get Lead Activity](https://docs.foxreach.io/api-reference/leads/get-lead-activity.md): Retrieve the activity timeline and campaign memberships for a lead.
- [List Leads](https://docs.foxreach.io/api-reference/leads/list-leads.md): Retrieve a paginated list of leads in your workspace.
- [Update Lead](https://docs.foxreach.io/api-reference/leads/update-lead.md): Update an existing lead. Only provided fields are changed.
- [Create Template](https://docs.foxreach.io/api-reference/templates/create-template.md): Create a new email template.
- [Delete Template](https://docs.foxreach.io/api-reference/templates/delete-template.md): Delete a template from your workspace.
- [Get Template](https://docs.foxreach.io/api-reference/templates/get-template.md): Retrieve a single template by ID.
- [List Templates](https://docs.foxreach.io/api-reference/templates/list-templates.md): Retrieve a paginated list of templates in your workspace.
- [Update Template](https://docs.foxreach.io/api-reference/templates/update-template.md): Update an existing template. Only provided fields are changed.
- [Create Webhook](https://docs.foxreach.io/api-reference/webhooks/create-webhook.md): Create a new webhook. A signing secret is auto-generated and returned once.
- [Delete Webhook](https://docs.foxreach.io/api-reference/webhooks/delete-webhook.md): Delete a webhook. It will stop receiving events immediately.
- [List Event Types](https://docs.foxreach.io/api-reference/webhooks/list-event-types.md): Retrieve the list of valid webhook event types you can subscribe to.
- [List Webhooks](https://docs.foxreach.io/api-reference/webhooks/list-webhooks.md): Retrieve a paginated list of webhooks in your workspace.
- [Update Webhook](https://docs.foxreach.io/api-reference/webhooks/update-webhook.md): Update an existing webhook's URL, events, or active status.
- [CLI](https://docs.foxreach.io/sdks/cli.md): Command-line interface for managing FoxReach leads, campaigns, templates, and more from your terminal.
- [Python SDK](https://docs.foxreach.io/sdks/python.md): Official Python SDK for the FoxReach API. Sync and async support, typed models, auto-pagination.
- [TypeScript / JavaScript SDK](https://docs.foxreach.io/sdks/typescript.md): Official TypeScript SDK for the FoxReach API. Zero dependencies, full type safety, auto-pagination.
- [Event Types](https://docs.foxreach.io/webhooks/events.md): Complete reference of all webhook event types you can subscribe to.
- [Webhooks Overview](https://docs.foxreach.io/webhooks/overview.md): Receive real-time notifications when events happen in your FoxReach account.
- [Signature Verification](https://docs.foxreach.io/webhooks/signatures.md): Verify webhook signatures to ensure requests are from FoxReach.

## OpenAPI Specs

- [openapi](https://docs.foxreach.io/openapi.json)