# Heffl Docs

## Docs

- [Authentication](https://docs.heffl.com/api-reference/authentication.md): How to authenticate with the Heffl API
- [Create a new client](https://docs.heffl.com/api-reference/clients/create-a-new-client.md): Creates a new client/company in your CRM. The client will be assigned to the user associated with your API key.
- [Delete a client](https://docs.heffl.com/api-reference/clients/delete-a-client.md): Permanently deletes a client. Will fail if the client has associated deals, invoices, or quotations.
- [Get a client](https://docs.heffl.com/api-reference/clients/get-a-client.md): Returns a single client by its public ID.
- [List clients](https://docs.heffl.com/api-reference/clients/list-clients.md): Returns a paginated list of clients. Supports search and type filtering.
- [Update a client](https://docs.heffl.com/api-reference/clients/update-a-client.md): Updates an existing client/company in your CRM. Only provided fields will be updated.
- [Create a new deal](https://docs.heffl.com/api-reference/deals/create-a-new-deal.md): Creates a new deal in your CRM pipeline.
- [Delete a deal](https://docs.heffl.com/api-reference/deals/delete-a-deal.md): Permanently deletes a deal. Will fail if the deal has associated quotations, projects, or documents.
- [Get a deal](https://docs.heffl.com/api-reference/deals/get-a-deal.md): Returns a single deal by its public ID.
- [List deals](https://docs.heffl.com/api-reference/deals/list-deals.md): Returns a paginated list of deals. Supports search and filtering.
- [Update a deal](https://docs.heffl.com/api-reference/deals/update-a-deal.md): Updates an existing deal. Only provided fields will be updated.
- [API Reference](https://docs.heffl.com/api-reference/introduction.md): Integrate with Heffl using the REST API
- [Create a new invoice](https://docs.heffl.com/api-reference/invoices/create-a-new-invoice.md): Creates a new invoice with line items. Returns the invoice with calculated totals.
- [Create a new lead](https://docs.heffl.com/api-reference/leads/create-a-new-lead.md): Creates a new lead in your CRM. The lead will be assigned to the user associated with your API key.
- [Delete a lead](https://docs.heffl.com/api-reference/leads/delete-a-lead.md): Permanently deletes a lead. This action cannot be undone.
- [Get a lead](https://docs.heffl.com/api-reference/leads/get-a-lead.md): Returns a single lead by its public ID.
- [List leads](https://docs.heffl.com/api-reference/leads/list-leads.md): Returns a paginated list of leads. Supports search and filtering.
- [Update a lead](https://docs.heffl.com/api-reference/leads/update-a-lead.md): Updates an existing lead in your CRM. Only provided fields will be updated.
- [Get a pipeline](https://docs.heffl.com/api-reference/reference-data/get-a-pipeline.md): Returns a single deal pipeline with its stages.
- [Get a product](https://docs.heffl.com/api-reference/reference-data/get-a-product.md): Returns a single product by public ID.
- [List deal pipelines](https://docs.heffl.com/api-reference/reference-data/list-deal-pipelines.md): Returns all deal pipelines with their stages.
- [List lead sources](https://docs.heffl.com/api-reference/reference-data/list-lead-sources.md): Returns all CRM sources (lead sources).
- [List lead stages](https://docs.heffl.com/api-reference/reference-data/list-lead-stages.md): Returns all lead stages ordered by position.
- [List products](https://docs.heffl.com/api-reference/reference-data/list-products.md): Returns a paginated list of products.
- [List tags](https://docs.heffl.com/api-reference/reference-data/list-tags.md): Returns all tags for your team, optionally filtered by type.
- [Create a new task](https://docs.heffl.com/api-reference/tasks/create-a-new-task.md): Creates a new task. The task will be assigned to the user associated with your API key.
- [Delete a task](https://docs.heffl.com/api-reference/tasks/delete-a-task.md): Permanently deletes a task.
- [Get a task](https://docs.heffl.com/api-reference/tasks/get-a-task.md): Returns a single task by its public ID.
- [List tasks](https://docs.heffl.com/api-reference/tasks/list-tasks.md): Returns a paginated list of tasks. Supports search and filtering.
- [Update a task](https://docs.heffl.com/api-reference/tasks/update-a-task.md): Updates an existing task. Only provided fields will be updated.
- [List users](https://docs.heffl.com/api-reference/users/list-users.md): Returns a paginated list of users who belong to the API key's team.
- [Webhook Events](https://docs.heffl.com/api-reference/webhook-events.md): Complete catalog of webhook event types and their payloads
- [Webhooks](https://docs.heffl.com/api-reference/webhooks.md): Receive real-time notifications when events happen in your workspace
- [Get webhook subscription](https://docs.heffl.com/api-reference/webhooks/get-webhook-subscription.md): Returns a single webhook endpoint.
- [List webhook subscriptions](https://docs.heffl.com/api-reference/webhooks/list-webhook-subscriptions.md): Returns webhook endpoints for your team.
- [Subscribe to webhook events](https://docs.heffl.com/api-reference/webhooks/subscribe-to-webhook-events.md): Creates a webhook endpoint that receives HTTP POST notifications when specified events occur.
- [Unsubscribe from webhook events](https://docs.heffl.com/api-reference/webhooks/unsubscribe-from-webhook-events.md): Deletes a webhook endpoint and stops receiving events.
- [Changelog](https://docs.heffl.com/changelog.md): Product updates and releases for Heffl.
- [Activities & Notes](https://docs.heffl.com/crm/activities.md): Track interactions and log notes across your CRM
- [Contacts & Companies](https://docs.heffl.com/crm/contacts.md): Manage individual contacts and company accounts
- [Deals](https://docs.heffl.com/crm/deals.md): Track sales opportunities through your pipeline
- [Leads](https://docs.heffl.com/crm/leads.md): Capture, qualify, and convert leads into deals
- [CRM Overview](https://docs.heffl.com/crm/overview.md): Manage your contacts, companies, deals, and leads in one place
- [Quick Start Guide](https://docs.heffl.com/getting-started/introduction.md): Get up and running with Heffl in minutes
- [Fathom AI Integration](https://docs.heffl.com/integrations/fathom.md): Automatically log meeting notes, summaries, and action items from Fathom to Heffl
- [LunaCal Integration](https://docs.heffl.com/integrations/lunacal.md): Automatically sync LunaCal bookings to Heffl contacts and deals
- [Smtp](https://docs.heffl.com/integrations/smtp.md)
- [Introduction](https://docs.heffl.com/introduction.md): Welcome to Heffl - the all-in-one business management platform
- [Automations](https://docs.heffl.com/modules/automations.md): Automate workflows with triggers and actions
- [Custom Fields](https://docs.heffl.com/modules/custom-fields.md): Add custom data fields to any entity in Heffl
- [Forms](https://docs.heffl.com/modules/forms.md): Build custom forms to capture leads and collect data
- [Inbox](https://docs.heffl.com/modules/inbox.md): Manage WhatsApp and LinkedIn conversations in one place
- [Modules Overview](https://docs.heffl.com/modules/overview.md): Explore Heffl's additional modules and capabilities
- [Managing Projects](https://docs.heffl.com/projects/managing-projects.md): Create and manage projects
- [Projects Overview](https://docs.heffl.com/projects/overview.md): Plan, track, and deliver projects with your team
- [Tasks](https://docs.heffl.com/projects/tasks.md): Create, assign, and manage tasks
- [Invoices](https://docs.heffl.com/sales/invoices.md): Create, send, and manage invoices
- [Sales Overview](https://docs.heffl.com/sales/overview.md): Manage your complete sales cycle from quotation to payment
- [Payments](https://docs.heffl.com/sales/payments.md): Record payments, manage payment methods, and collect online
- [Products & Services](https://docs.heffl.com/sales/products.md): Manage your product catalog
- [Quotations](https://docs.heffl.com/sales/quotations.md): Create professional quotes and proposals
- [Developer Settings](https://docs.heffl.com/settings/developer.md): API keys and webhook configuration for developers
- [Integrations](https://docs.heffl.com/settings/integrations.md): Connect third-party services to extend Heffl
- [Settings](https://docs.heffl.com/settings/overview.md): Configure every aspect of your Heffl workspace
- [Team Management](https://docs.heffl.com/settings/team-management.md): Invite members, assign roles, and configure permissions
- [Workspace](https://docs.heffl.com/workspace/overview.md): Manage your team, roles, and organization settings in Heffl

## OpenAPI Specs

- [openapi](https://docs.heffl.com/openapi.json)