# Twenty Documentation

## Docs

- [Local Setup](https://docs.twenty.com/developers/contribute/capabilities/local-setup.md): The guide for contributors (or curious developers) who want to run Twenty locally.
- [Commands](https://docs.twenty.com/developers/contribute/commands.md): Useful commands for developing Twenty.
- [Style Guide](https://docs.twenty.com/developers/contribute/style-guide.md): Code conventions and best practices for contributing to Twenty.
- [APIs](https://docs.twenty.com/developers/extend/api.md): REST and GraphQL APIs generated from your workspace schema.
- [Architecture](https://docs.twenty.com/developers/extend/apps/building.md): How Twenty apps work — sandboxing, lifecycle, and the building blocks.
- [CLI & Testing](https://docs.twenty.com/developers/extend/apps/cli-and-testing.md): CLI commands, testing setup, public assets, npm packages, remotes, and CI configuration.
- [Data Model](https://docs.twenty.com/developers/extend/apps/data-model.md): Define objects, fields, roles, and application metadata with the Twenty SDK.
- [Front Components](https://docs.twenty.com/developers/extend/apps/front-components.md): Build React components that render inside Twenty's UI with sandboxed isolation.
- [Getting Started](https://docs.twenty.com/developers/extend/apps/getting-started.md): Create your first Twenty app in minutes.
- [Layout](https://docs.twenty.com/developers/extend/apps/layout.md): Define views, navigation menu items, and page layouts to shape how your app appears in Twenty.
- [Logic Functions](https://docs.twenty.com/developers/extend/apps/logic-functions.md): Define server-side TypeScript functions with HTTP, cron, and database event triggers.
- [Publishing](https://docs.twenty.com/developers/extend/apps/publishing.md): Distribute your Twenty app to the marketplace or deploy it internally.
- [Skills & Agents](https://docs.twenty.com/developers/extend/apps/skills-and-agents.md): Define AI skills and agents for your app.
- [OAuth](https://docs.twenty.com/developers/extend/oauth.md): Authorization code flow with PKCE and client credentials for server-to-server access.
- [Webhooks](https://docs.twenty.com/developers/extend/webhooks.md): Get notified when records change — HTTP POST to your endpoint on every create, update, or delete.
- [Developers](https://docs.twenty.com/developers/introduction.md): Build apps, use the API, self-host, or contribute to the codebase.
- [Other methods](https://docs.twenty.com/developers/self-host/capabilities/cloud-providers.md)
- [Docker Compose](https://docs.twenty.com/developers/self-host/capabilities/docker-compose.md)
- [Setup](https://docs.twenty.com/developers/self-host/capabilities/setup.md)
- [Troubleshooting](https://docs.twenty.com/developers/self-host/capabilities/troubleshooting.md)
- [Upgrade guide](https://docs.twenty.com/developers/self-host/capabilities/upgrade-guide.md)
- [AI](https://docs.twenty.com/getting-started/core-concepts/ai.md): How Twenty uses AI to enhance your CRM experience.
- [Apps](https://docs.twenty.com/getting-started/core-concepts/apps.md): Extend Twenty with code — custom objects, server-side logic, UI components, and AI agents, all as TypeScript packages.
- [Calendar & Email](https://docs.twenty.com/getting-started/core-concepts/calendar-and-email.md): Sync your email and calendar with Twenty.
- [Dashboards](https://docs.twenty.com/getting-started/core-concepts/dashboards.md): Track performance and visualize your CRM data with custom dashboards.
- [Data Model](https://docs.twenty.com/getting-started/core-concepts/data-model.md): Understand how Twenty structures your data with objects, fields, and relations.
- [Glossary](https://docs.twenty.com/getting-started/core-concepts/glossary.md): Key terms used throughout Twenty.
- [Layout](https://docs.twenty.com/getting-started/core-concepts/layout.md): How to navigate, browse, and view records in Twenty.
- [Workflows](https://docs.twenty.com/getting-started/core-concepts/workflows.md): Automate your business processes with Twenty's visual workflow builder.
- [Why Twenty](https://docs.twenty.com/getting-started/introduction.md)
- [Key Features](https://docs.twenty.com/getting-started/key-features.md): A tour of everything Twenty can do — from custom data models to AI-powered automation.
- [Quickstart](https://docs.twenty.com/getting-started/quickstart.md): Get Twenty up and running in under 5 minutes — on the cloud or self-hosted.
- [AI Agents](https://docs.twenty.com/user-guide/ai/capabilities/ai-agents.md): Integrate AI capabilities directly into your automation workflows.
- [AI Chatbot](https://docs.twenty.com/user-guide/ai/capabilities/ai-chatbot.md): An intelligent assistant that helps you interact with your CRM data using natural language.
- [Permissions & Access Control](https://docs.twenty.com/user-guide/ai/capabilities/permissions-access-control.md): Control what AI agents can access and modify in your workspace.
- [AI FAQ](https://docs.twenty.com/user-guide/ai/how-tos/ai-faq.md): Frequently asked questions about AI features in Twenty.
- [AI](https://docs.twenty.com/user-guide/ai/overview.md): AI-powered features coming soon to Twenty.
- [Credits](https://docs.twenty.com/user-guide/billing/capabilities/credits.md): Understanding how credits power workflows, AI agents, and the AI chatbot — and how to manage your balance.
- [Pricing Plans](https://docs.twenty.com/user-guide/billing/capabilities/pricing-plans.md): Learn about Twenty's pricing plans and how to switch between them.
- [Billing FAQ](https://docs.twenty.com/user-guide/billing/how-tos/billing-faq.md): Frequently asked questions about Twenty pricing and billing.
- [Billing](https://docs.twenty.com/user-guide/billing/overview.md): Understand Twenty pricing and manage your subscription.
- [Calendar](https://docs.twenty.com/user-guide/calendar-emails/capabilities/calendar.md): Understanding calendar integration features in Twenty.
- [Mailbox](https://docs.twenty.com/user-guide/calendar-emails/capabilities/mailbox.md): Understanding email integration features in Twenty.
- [Can I Book Meetings from Twenty?](https://docs.twenty.com/user-guide/calendar-emails/how-tos/can-i-book-meetings-from-twenty.md): Information about booking meetings directly from Twenty.
- [Can I Send Emails from Twenty?](https://docs.twenty.com/user-guide/calendar-emails/how-tos/can-i-send-emails-from-twenty.md): Information about sending emails directly from Twenty.
- [Can I Track Email Activity on All Objects?](https://docs.twenty.com/user-guide/calendar-emails/how-tos/can-i-track-email-activity-on-all-objects.md): Understanding email activity tracking across different objects.
- [Connect Several Mailboxes per User](https://docs.twenty.com/user-guide/calendar-emails/how-tos/connect-several-mailboxes-per-user.md): Connect multiple email accounts for a single user.
- [I Don't See Emails on Records](https://docs.twenty.com/user-guide/calendar-emails/how-tos/i-dont-see-emails-on-records.md): Troubleshooting missing emails on records.
- [Limit Emails Imported](https://docs.twenty.com/user-guide/calendar-emails/how-tos/limit-emails-imported.md): Control which emails are imported into Twenty.
- [Calendar & Emails](https://docs.twenty.com/user-guide/calendar-emails/overview.md): Connect your email and calendar accounts to Twenty.
- [Chart Settings](https://docs.twenty.com/user-guide/dashboards/capabilities/chart-settings.md): Configure your charts to display data exactly how you need it.
- [Dashboards](https://docs.twenty.com/user-guide/dashboards/capabilities/dashboards.md): Create and organize dashboards with tabs to visualize your CRM data.
- [Widgets](https://docs.twenty.com/user-guide/dashboards/capabilities/widgets.md): Explore the widget types and visualization options in Twenty.
- [Dashboards FAQ](https://docs.twenty.com/user-guide/dashboards/how-tos/dashboards-faq.md): Frequently asked questions about dashboards in Twenty.
- [Widget FAQ](https://docs.twenty.com/user-guide/dashboards/how-tos/widget-faq.md): Common questions and error messages explained.
- [Dashboards](https://docs.twenty.com/user-guide/dashboards/overview.md): Learn the basics of reporting and dashboards in Twenty.
- [Error Handling & Validation](https://docs.twenty.com/user-guide/data-migration/capabilities/error-handling.md): Review and fix import errors directly in the UI before confirming.
- [Field Mapping](https://docs.twenty.com/user-guide/data-migration/capabilities/field-mapping.md): How field mapping works during data import.
- [Supported File Formats](https://docs.twenty.com/user-guide/data-migration/capabilities/file-formats.md): File formats supported for data import in Twenty.
- [Import Relations Between Objects](https://docs.twenty.com/user-guide/data-migration/capabilities/import-relations.md): Import relationships between records via CSV.
- [Uniqueness Constraints](https://docs.twenty.com/user-guide/data-migration/capabilities/uniqueness-constraints.md): How Twenty enforces data uniqueness during import.
- [Export Your Data](https://docs.twenty.com/user-guide/data-migration/how-tos/export-your-data.md): Complete step-by-step guide to exporting data from Twenty.
- [Fix Import Errors](https://docs.twenty.com/user-guide/data-migration/how-tos/fix-import-errors.md): Complete troubleshooting guide for resolving CSV import errors.
- [Import Companies via CSV](https://docs.twenty.com/user-guide/data-migration/how-tos/import-companies-via-csv.md): Complete step-by-step guide to importing companies into Twenty.
- [Import Contacts via CSV](https://docs.twenty.com/user-guide/data-migration/how-tos/import-contacts-via-csv.md): Complete step-by-step guide to importing people/contacts into Twenty.
- [Import Data via API](https://docs.twenty.com/user-guide/data-migration/how-tos/import-data-via-api.md): When and how to use Twenty's APIs for large-scale data imports.
- [Import Relations Between Objects via CSV](https://docs.twenty.com/user-guide/data-migration/how-tos/import-relations-between-objects-via-csv.md): Complete step-by-step guide to linking records during CSV import.
- [Migrating from Other CRMs](https://docs.twenty.com/user-guide/data-migration/how-tos/migrating-from-other-crms.md): Step-by-step guide to migrate your data from any CRM to Twenty.
- [Migrating from Self-Hosted to Cloud](https://docs.twenty.com/user-guide/data-migration/how-tos/migrating-from-self-hosted-to-cloud.md): Step-by-step guide to migrate your Twenty self-hosted instance to Twenty Cloud.
- [Prepare Your CSV Files](https://docs.twenty.com/user-guide/data-migration/how-tos/prepare-your-csv-files.md): Complete step-by-step guide to format your data for import into Twenty.
- [Update Existing Records via Import](https://docs.twenty.com/user-guide/data-migration/how-tos/update-existing-records-via-import.md): Complete step-by-step guide to bulk updating records using CSV import.
- [Data Migration](https://docs.twenty.com/user-guide/data-migration/overview.md): Import and export your CRM data via CSV files or API.
- [Fields](https://docs.twenty.com/user-guide/data-model/capabilities/fields.md): Understand the role of fields and how to manage them.
- [Objects](https://docs.twenty.com/user-guide/data-model/capabilities/objects.md): Learn about standard and custom objects in Twenty.
- [Relation Fields](https://docs.twenty.com/user-guide/data-model/capabilities/relation-fields.md): Connect records across different objects using relation fields.
- [Create Custom Fields](https://docs.twenty.com/user-guide/data-model/how-tos/create-custom-fields.md): Step-by-step guide to adding custom fields to any object.
- [Create Custom Objects](https://docs.twenty.com/user-guide/data-model/how-tos/create-custom-objects.md): Step-by-step guide to creating custom objects in Twenty.
- [Create Many-to-Many Relations](https://docs.twenty.com/user-guide/data-model/how-tos/create-many-to-many-relations.md): Connect records where many items on both sides can be linked together using junction objects.
- [Create Relation Fields](https://docs.twenty.com/user-guide/data-model/how-tos/create-relation-fields.md): Step-by-step guide to connecting objects with relation fields.
- [Customize Your Data Model](https://docs.twenty.com/user-guide/data-model/how-tos/customize-your-data-model.md): Overview of data model customization options.
- [Data Model FAQ](https://docs.twenty.com/user-guide/data-model/how-tos/data-model-faq.md): Frequently asked questions about Twenty's data model.
- [Data Model](https://docs.twenty.com/user-guide/data-model/overview.md): Learn what a data model is and how to design one that fits your business.
- [User Guide](https://docs.twenty.com/user-guide/introduction.md): Welcome to Twenty User Guide, your resources for advanced configurations and best practices.
- [Navigation](https://docs.twenty.com/user-guide/layout/capabilities/navigation.md): Customize the left sidebar to match how your team works.
- [Record Pages](https://docs.twenty.com/user-guide/layout/capabilities/record-pages.md): Customize the layout of individual record detail pages with tabs and widgets.
- [Layout](https://docs.twenty.com/user-guide/layout/overview.md): Customize how you navigate, browse, and view records in Twenty.
- [Permissions](https://docs.twenty.com/user-guide/permissions-access/capabilities/permissions.md): Control access to objects, fields, and settings with role-based permissions.
- [SSO Configuration](https://docs.twenty.com/user-guide/permissions-access/capabilities/sso-configuration.md): Configure Single Sign-On for secure enterprise authentication.
- [Permissions FAQ](https://docs.twenty.com/user-guide/permissions-access/how-tos/permissions-faq.md): Frequently asked questions about roles and permissions.
- [Permissions & Access](https://docs.twenty.com/user-guide/permissions-access/overview.md): Manage roles, permissions, and access control in your workspace.
- [Domain Settings](https://docs.twenty.com/user-guide/settings/capabilities/domains-settings.md): Configure workspace domain, approved access domains, and public domains.
- [Experience Settings](https://docs.twenty.com/user-guide/settings/capabilities/experience-settings.md): Customize your interface theme and regional preferences.
- [Member Management](https://docs.twenty.com/user-guide/settings/capabilities/member-management.md): Invite team members and manage workspace access.
- [Profile Settings](https://docs.twenty.com/user-guide/settings/capabilities/profile-settings.md): Manage your personal profile and security settings.
- [Updates Settings](https://docs.twenty.com/user-guide/settings/capabilities/updates-settings.md): Enable Early Access features in Twenty.
- [Workspace Settings](https://docs.twenty.com/user-guide/settings/capabilities/workspace-settings.md): Customize your workspace name and branding.
- [Settings FAQ](https://docs.twenty.com/user-guide/settings/how-tos/settings-faq.md): Frequently asked questions about Twenty settings.
- [Settings](https://docs.twenty.com/user-guide/settings/overview.md): Set up your Twenty workspace with essential configurations.
- [Calendar View](https://docs.twenty.com/user-guide/views-pipelines/capabilities/calendar-view.md): Display records with date fields on a calendar.
- [Fields & Columns](https://docs.twenty.com/user-guide/views-pipelines/capabilities/fields-and-columns.md): Choose which fields to display and how to organize them.
- [Filters & Sorting](https://docs.twenty.com/user-guide/views-pipelines/capabilities/filters-and-sorting.md): Filter and sort records to find exactly what you need.
- [Kanban Board Views](https://docs.twenty.com/user-guide/views-pipelines/capabilities/kanban-views.md): Learn how to use Kanban views to visualize and manage your workflows.
- [Table Views](https://docs.twenty.com/user-guide/views-pipelines/capabilities/table-views.md): Display your data in a spreadsheet-like list format.
- [View Settings](https://docs.twenty.com/user-guide/views-pipelines/capabilities/view-settings.md): Manage view visibility, naming, icons, and organization.
- [Create a Calendar View for Tasks Due](https://docs.twenty.com/user-guide/views-pipelines/how-tos/create-a-calendar-view-for-tasks-due.md): Visualize your tasks and deadlines on a calendar.
- [Create a Kanban View for Projects](https://docs.twenty.com/user-guide/views-pipelines/how-tos/create-a-kanban-view-for-projects.md): Track projects through stages using a visual board.
- [Create a Table View with Grouping](https://docs.twenty.com/user-guide/views-pipelines/how-tos/create-a-table-view-with-grouping.md): Organize your records into collapsible groups by field value.
- [Restrict Access to Your View](https://docs.twenty.com/user-guide/views-pipelines/how-tos/restrict-access-to-your-view.md): Control who can see your custom views.
- [Set Up a Sales Pipeline](https://docs.twenty.com/user-guide/views-pipelines/how-tos/set-up-a-sales-pipeline.md): Configure your sales pipeline to track opportunities through stages.
- [Show Expected Amount in Your Pipeline](https://docs.twenty.com/user-guide/views-pipelines/how-tos/show-expected-amount-in-pipeline.md): Calculate and display weighted deal values based on stage probability.
- [Track How Long Opportunities Stay in Each Stage](https://docs.twenty.com/user-guide/views-pipelines/how-tos/track-time-in-stage.md): Monitor deal velocity by tracking when opportunities enter each stage.
- [Send Emails from Workflows](https://docs.twenty.com/user-guide/workflows/capabilities/send-emails-from-workflows.md): Send personalized emails automatically using workflow actions.
- [Use Branches in Workflows](https://docs.twenty.com/user-guide/workflows/capabilities/use-branches-in-workflows.md): Understand how branches work and how to control which path is executed.
- [Use Iterator](https://docs.twenty.com/user-guide/workflows/capabilities/use-iterator.md): Loop through arrays of records to perform actions on each item.
- [Workflow Actions](https://docs.twenty.com/user-guide/workflows/capabilities/workflow-actions.md): Learn about the actions available in Twenty workflows.
- [Workflow Branches](https://docs.twenty.com/user-guide/workflows/capabilities/workflow-branches.md): Create parallel paths and conditional logic in your workflows.
- [Workflow Credits](https://docs.twenty.com/user-guide/workflows/capabilities/workflow-credits.md): Understand workflow credit consumption and management.
- [Workflow Runs](https://docs.twenty.com/user-guide/workflows/capabilities/workflow-runs.md): Monitor and manage workflow executions.
- [Workflow Triggers](https://docs.twenty.com/user-guide/workflows/capabilities/workflow-triggers.md): Learn about the different triggers that start your workflows.
- [Workflow Versions](https://docs.twenty.com/user-guide/workflows/capabilities/workflow-versions.md): Manage workflow versions and drafts.
- [Handle Arrays in Code Actions](https://docs.twenty.com/user-guide/workflows/how-tos/advanced-configurations/handle-arrays-in-code-actions.md): Learn how to properly handle array inputs in workflow Code actions.
- [Bring Product Data into Twenty](https://docs.twenty.com/user-guide/workflows/how-tos/connect-to-other-tools/bring-product-data-in-twenty.md): Sync product catalog data from a data warehouse into your CRM on a schedule.
- [Bring Typeform Submissions into Twenty](https://docs.twenty.com/user-guide/workflows/how-tos/connect-to-other-tools/bring-typeform-submissions-in-twenty.md): Handle Typeform's webhook payload to create leads from form submissions.
- [Generate a PDF from Twenty](https://docs.twenty.com/user-guide/workflows/how-tos/connect-to-other-tools/generate-pdf-from-twenty.md): Create a workflow to generate and attach a PDF (such as a quote) to a record.
- [Generate a Quote or Invoice from Twenty](https://docs.twenty.com/user-guide/workflows/how-tos/connect-to-other-tools/generate-quote-or-invoice-from-twenty.md): Automatically create invoices in external tools when deals close.
- [Set Up a Webhook Trigger](https://docs.twenty.com/user-guide/workflows/how-tos/connect-to-other-tools/set-up-a-webhook-trigger.md): Receive data from external services to trigger workflows.
- [Auto-Reply to Inbound Emails](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/auto-reply-to-inbound-emails.md): Build a workflow that uses AI to triage incoming emails and send threaded replies automatically.
- [Closed Won Automations](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/closed-won-automations.md): Automate post-win activities when opportunities close.
- [Detect Stale Opportunities](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/detect-stale-opportunities.md): Automatically notify managers when opportunities haven't been updated.
- [Display Number of Emails Received](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/display-number-of-emails-received.md): Create a workflow to automatically count and display the number of emails received from each contact.
- [Display Related Record Data](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/display-related-record-data.md): Show data from related records (e.g., Company info on Opportunities) using workflows.
- [Formula Fields](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/formula-fields.md): Create formula fields using workflows until native support is available.
- [Notify Teammates of a Note to Review](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/notify-teammates-of-note-to-review.md): Send automatic email notifications when assigning a colleague to review a note.
- [Send Email Alerts with Tasks Due](https://docs.twenty.com/user-guide/workflows/how-tos/crm-automations/send-email-alerts-with-tasks-due.md): Automatically notify team members about their upcoming or overdue tasks.
- [Professional Services](https://docs.twenty.com/user-guide/workflows/how-tos/need-more-help/professional-services.md): Get professional help building complex workflows and automations from Twenty's team and certified partners.
- [Workflow Troubleshooting](https://docs.twenty.com/user-guide/workflows/how-tos/need-more-help/workflow-troubleshooting.md): Common workflow issues and how to resolve them.
- [Workflows FAQ](https://docs.twenty.com/user-guide/workflows/how-tos/need-more-help/workflows-faq.md): Frequently asked questions about workflows in Twenty.
- [Workflows](https://docs.twenty.com/user-guide/workflows/overview.md): Learn how to build automations in Twenty.

## OpenAPI Specs

- [openapi](https://docs.twenty.com/api-reference/openapi.json)