snapshot of https://github.com/twentyhq/twenty.git (main, 2026-09-17; blobs > 131072B omitted)

packages/twenty-docs/user-guide/getting-started/capabilities/glossary.mdx

@@ -0,0 +1,80 @@
+---
+title: Glossary
+description: Get familiar with essential terminology used in Twenty.
+---
+
+## API
+API (Application Programming Interface) allows you to connect Twenty with other software systems and build custom integrations.
+
+## Apps
+Apps are custom extensions built as code that can define data models and logic functions. They enable developers to create reusable customizations that can be deployed across multiple workspaces.
+
+## Code Actions
+Code Actions are workflow steps that let you write custom JavaScript to transform data, make calculations, or perform complex logic that isn't possible with built-in actions.
+
+## Command Menu
+The Command Menu is a quick-access interface (opened with `Cmd + K` on Mac and `Ctrl + K` on Windows) that lets you perform actions, create records, and navigate your workspace efficiently.
+
+## Company & People
+The CRM has two fundamental types of records:
+- A `Company` represents a business or organization.
+- `People` represent your company's current and prospective customers or clients.
+
+## Custom Fields
+Custom Fields are data fields you create to capture information specific to your business needs and processes.
+
+## Data Model
+A Data Model is the structure that defines how information is organized in your CRM, including what objects exist, their properties (fields), and how they relate to each other.
+
+## Favorites
+Favorites are records you've marked for quick access, appearing in your sidebar for instant navigation to important data.
+
+## Field
+A field refers to a specific area where particular data is stored for an entity.
+
+## Iterator
+An Iterator is a workflow action that loops through an array of items, executing subsequent actions for each item in the list.
+
+## Kanban
+A `Kanban` is a visual way to track your business processes using cards and columns. Each column represents a stage in your process (for example: new, ongoing, won, lost), and you move records through these stages as they progress.
+
+## Object
+An Object is a data structure that represents a specific type of entity in your CRM (like People, Companies, or Opportunities). Objects can be standard (built-in) or custom (created by you).
+
+## Opportunities
+Opportunities in Twenty CRM are potential deals or sales with accounts or contacts.
+
+## Record
+A Record is an instance of an object, like a specific account or contact.
+
+## Relation Fields
+Relation Fields create connections between different objects, allowing you to link records together (like connecting a Person to a Company).
+
+## Standard Fields
+Standard Fields are pre-built data fields that come with objects by default and provide common functionality across all workspaces.
+
+## Tasks
+Tasks in Twenty CRM are assigned activities relating to contacts, accounts, or opportunities.
+
+## Triggers
+Triggers are the starting point of a workflow — the event or condition that initiates the automation. Examples include record creation, record updates, webhooks, or scheduled times.
+
+## Views
+You can customize the display of your records using views, setting different filters, layouts and sorting options for each view.
+
+## Upsert
+Upsert is an operation that combines "update" and "insert" — it updates an existing record if a match is found, or creates a new record if no match exists.
+
+## Webhooks
+Webhooks are automated messages sent from Twenty to other applications when specific events occur, enabling real-time data synchronization.
+
+## Workflows
+Workflows are automated processes that trigger actions based on specific conditions, helping you automate repetitive tasks and business processes.
+
+## Workspace
+A `Workspace` typically represents a company using Twenty. It holds all the records and data that you and your team members add to Twenty.
+It has a single domain name, which is typically the domain name your company uses for employee email addresses.
+
+## Workspace Members
+Workspace Members are the Twenty users from your team who have access to your workspace. They can be assigned as owners or assignees for records.
+

packages/twenty-docs/user-guide/getting-started/capabilities/implementation-services.mdx

@@ -0,0 +1,17 @@
+---
+title: Implementation Services
+description: Whether you need help getting started or creating advanced customizations, we have a solution.
+---
+
+## Implementation Partners
+
+Work with certified Twenty partners for advanced customizations, integrations, and dedicated implementation support.
+
+<CardGroup cols={2}>
+  <Card title="Browse certified partners" icon="magnifying-glass" href="https://twenty.com/partners/list?ref=docs-implementation-services">
+    Find a partner and reach out directly — filter by region, language, and expertise.
+  </Card>
+  <Card title="Get matched by Twenty" icon="envelope" href="mailto:contact@twenty.com">
+    Tell us what you need and we'll connect you with the right partner.
+  </Card>
+</CardGroup>

packages/twenty-docs/user-guide/getting-started/capabilities/what-is-twenty.mdx

@@ -0,0 +1,44 @@
+---
+title: What is Twenty
+description: Twenty is an open-source CRM that gives you the building blocks to create exactly what your business needs.
+---
+
+## Vision
+Creating a good CRM is hard because it's a balancing act.
+For each business, the requirements seem straightforward, yet everyone's needs are distinct.
+The result is a CRM that's either too basic, or one that's attempting to be a jack-of-all-trades but ending up as a master of none.
+
+At first, Twenty looks like most CRMs you already know: you can track deals, organize contacts, manage tasks and notes.
+**But what sets it apart is our approach to extensibility. We are building an open platform that provides the building blocks for you to solve your unique business problems.**
+
+We prioritize universal principles and common patterns over feature lists.
+We don't try to have all the answers and instead empower users to find what works best for them.
+Open-source is the bedrock of our approach, ensuring that Twenty evolves with its community, for its community.
+
+## Benefits
+
+**Customizable:** Designed to fit your business needs.
+
+**Community-driven:** Built and maintained by a large open-source community.
+
+**Cost-effective:** You'll never be vendor-locked, because you can always self-host.
+
+
+
+## Main Features
+
+- **Calendar & Emails:** Sync your mailbox and calendar to see all communications on your CRM records. [Learn more](/user-guide/calendar-emails/overview).
+- **Data Model:** Create custom objects and fields to match your unique business processes. [Explore](/user-guide/data-model/overview).
+- **Data Migration:** Import and export your data via CSV or API. [Get started](/user-guide/data-migration/overview).
+- **Views & Pipelines:** Organize your data with table views, kanban boards, and sales pipelines. [Discover](/user-guide/views-pipelines/overview).
+- **Workflows:** Automate your business processes and integrate with external tools. [Build automations](/user-guide/workflows/overview).
+- **AI:** Enhance your CRM with AI-powered features and agents. [Explore AI](/user-guide/ai/overview).
+- **Dashboards:** Track performance with custom reports and visualizations. [View dashboards](/user-guide/dashboards/overview).
+- **Permissions & Access:** Control who can view, edit, and manage your data with role-based permissions. [Configure access](/user-guide/permissions-access/overview).
+- **Notes & Tasks:** Create notes and tasks linked to your records for better collaboration.
+- **API & Webhooks:** Connect to other apps and build custom integrations. [Start integrating](/developers/extend/api).
+
+
+## Join Now
+
+[Register here](https://app.twenty.com) or [become a contributor on GitHub](https://github.com/twentyhq/twenty).

packages/twenty-docs/user-guide/getting-started/how-tos/configure-your-workspace.mdx

@@ -0,0 +1,67 @@
+---
+title: Configure Your Workspace
+description: "Every business works differently. Start with these 3 steps to shape Twenty around your needs."
+---
+
+<Note>**Quick Win**: Start with connecting your mailbox. This gives you immediate value and helps your team see Twenty in action with real data. You can do so under Settings → Accounts.</Note>
+
+## 1. Customize your data model
+Twenty offers the flexibility you need to shape the data model that will best support your day-to-day.
+Create objects and fields of any type, including relations between your different objects. You can do so under Settings → Data Model.
+Here are a few tips:
+- **You are not limited in the number of custom fields or custom objects**. Adding custom objects and fields will not lead to upgrading your plan.
+- **People, Companies and Opportunities are the three objects from where you can access the emails and meetings synchronized from your mailbox and calendar**. We recommend using those as much as possible, adding fields to categorize your records if need be. Here is an example:
+    - It is best to use the People object for your prospects and partners, creating a field on the People object named ```Person Type```, instead of creating a Partner custom object, because you would not be able to access the emails exchanged with this person from the Partner records.
+    - Create different views under People, one to display partners and one to display prospects.
+- Two People cannot have the same email address. Two Companies cannot have the same domain.
+- You can deactivate standard fields and objects you do not want to use.
+- You can hide fields from views: don't be afraid of creating fields, you won't have to display all of them.
+
+Read [this article](/user-guide/data-model/overview) to learn how to design your data model.
+
+## 2. Bring your data in
+Bringing your existing data into Twenty gives your team context from the start.
+
+### Connect your mailbox
+If you have not done so when creating your workspace, connect your **Google or Microsoft account** under Settings → Accounts. This allows Twenty to:
+- Import your messages and meetings
+- Auto-create contacts based on interactions (optional)
+- Keep communication history visible for your team
+
+**Using another provider?**
+You can add another mailbox via SMTP or another calendar via CalDAV. Go to **Settings → Accounts** to configure.
+
+### Import data via CSV
+Use the Command menu (```Cmd + K``` or ```Ctrl + K```) to import People, Companies, Opportunities, or any custom objects via CSV.
+
+**Key guidelines**:
+- Download the sample file to understand the expected format
+- Limit each file to 10k records
+- Remove duplicate emails for People or duplicate domains for Companies
+- Review and fix errors (highlighted in yellow) before importing
+
+Read [this article](/user-guide/data-migration/overview) to learn more about data import.
+
+## 3. Create your first view
+Creating different views is key to making the data actionable for your team.
+Here is how to proceed:
+-  **Add or hide columns**
+    Manage the fields visible in a given view by clicking on Options → Fields (from the top right). You can show/hide fields from there.
+
+- **Reorder fields**
+    Reorder the fields from a given view by clicking on Options → Fields (from the top right). Drag and drop the fields to reorder them.
+
+- **Filter your view**
+    Narrow down the records displayed using the Filters from the top right.
+
+- **Sort records**
+    Reorder records displayed using the Sort function from the top right, or by clicking directly on the column name.
+
+-  **Choose the layout**
+    You can switch to a **Kanban layout** or a list **Group By** layout, as long as the object has a `Stage` or similar select-type field.
+
+- **Save your view as Favorites**
+    This can be done using the dropdown menu showing the different views.
+
+## What's next?
+Start creating automations using [workflows](/user-guide/workflows/overview).

packages/twenty-docs/user-guide/getting-started/how-tos/create-workspace.mdx

@@ -0,0 +1,43 @@
+---
+title: Create a Workspace
+description: Follow a step-by-step guide on how to register on Twenty, choose a subscription plan, and set up your account.
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+## Step 1: Registration
+1. Navigate to [Twenty Sign Up](https://app.twenty.com).
+2. Select your preferred sign-up method:
+    - **Continue with Google** for Google account registration.
+    - **Continue with Microsoft** for Microsoft account registration.
+    - Or, **Continue with Email** for email registration.
+
+<VimeoEmbed videoId="927066829" title="Video demonstration" />
+
+## Step 2: Choosing a Trial Period
+
+Choose between two trial periods:
+
+### 30 days
+With credit card
+
+### 7 days
+Without credit card
+
+Both trials include:
+-  Full access
+-  Unlimited contacts
+-  Email integration
+-  Custom objects
+-  API & Webhooks
+
+You can click on "Change plan" to choose a different plan or billing interval.
+
+<img src="/images/user-guide/create-workspace/choose-plan.png" style={{width:'100%'}}/>
+
+## Step 3: Payment Confirmation & Account Setup
+After payment approval via Stripe, you're directed to create your workspace and user profile. Remember that you can cancel your subscription anytime.
+
+## Support
+For queries or help, connect with the dedicated support team at [contact@twenty.com](mailto:contact@twenty.com) or send a message on [Discord](https://discord.gg/cx5n4Jzs57).
+

packages/twenty-docs/user-guide/getting-started/how-tos/navigate-around-twenty.mdx

@@ -0,0 +1,81 @@
+---
+title: Navigate Around Twenty
+description: Get a quick overview of how to navigate through the platform and where to take different types of actions.
+---
+
+## The Main Layout
+The center of the screen is **where your records live**: People, Companies, Opportunities, Tasks, Notes, Dashboards, Workflows and any other object you created. This is where the day-to-day work happens.
+You can **view, edit, or delete records** from there, as well as **create new views**.
+
+<img src="/images/user-guide/home/main-layout.png" style={{width:'100%'}}/>
+
+
+<span id="the-navigation-bar" />
+
+## The Sidebar
+On the left side, from the top to the bottom, you'll be able to:
+- Switch between your **several workspaces** using the dropdown menu or create a new workspace
+- Use the **search bar** (press `/` to focus on it instantly)
+- Open the **Settings** section
+- Have direct access to your **Favorite views**. Favorites are unique for each user.
+- Switch between different objects
+- **Create automations** using workflows
+
+Use the collapse button at the top of the sidebar, or choose **Collapse sidebar** from the command menu. When collapsed, use **Expand sidebar** to show it again.
+
+<img src="/images/user-guide/home/navigation-bar.png" style={{width:'100%'}}/>
+
+## The Command Menu
+
+The command menu gives you **quick access to actions** in Twenty. You can access it in two ways:
+- **Keyboard shortcut**: Press `Cmd + K` (Mac) or `Ctrl + K` (Windows)
+- **Mouse**: Click the three dots in the top right corner
+From there, you can:
+- Create new records
+- **Import and export data via CSV**
+- Create new views
+- Access deleted records (Twenty supports soft and hard deletes)
+- See the keyboard shortcuts to quickly access objects in your workspace
+
+<img src="/images/user-guide/home/command-menu.png" style={{width:'100%'}}/>
+
+## The Search Bar
+The search bar is accessible via the Command Menu, at the top of your sidebar, or by pressing `/` to focus on it instantly. Search works across all objects.
+
+<img src="/images/user-guide/home/search-bar.png" style={{width:'100%'}}/>
+
+## The Side Panel
+When you click on a record, the side panel appears on the right. This gives you a quick overview of the record's key information, without bringing you to another page. From there, you can decide to close this overview or to get additional information about this record, by clicking on the Open button.
+
+<img src="/images/user-guide/home/side-panel.png" style={{width:'100%'}}/>
+
+
+
+## Views
+Every object (like Opportunities or People) supports multiple views. You're not limited in the number of views per object.
+
+Use the dropdown menu at the top left of the main layout to switch between the different views. For example:
+- Use a Kanban view to track opportunities by stage
+- Use Group By view to create sections and improve efficiency
+- Use filters to focus on specific records (e.g. leads created last week)
+- Save filtered views to reuse them later
+- Favorite views for fast access
+
+<img src="/images/user-guide/home/view-menu.png" style={{width:'100%'}}/>
+
+If you're new to Views, read our [Views & Pipelines guide](/user-guide/views-pipelines/overview) to learn how to create and customize them.
+
+## Settings
+Open your Settings from the top left to:
+- **Connect your mailbox and calendar** accounts for seamless email and calendar sync
+- Customize your **data model**: create custom objects, fields, and relationships
+- **Access the API playground and configure webhooks**
+- **Manage user permissions** and workspace access controls
+- Invite team members and manage user roles
+- Edit your profile and workspace preferences
+- Configure billing and monitor workflow credits usage
+- Discover and enable upcoming features (under Updates → Early Access)
+- **Access Support** to reach out via live chat
+- **Open the Documentation** to browse the User Guide and developer docs
+
+<Note>If you do not see all those sections under Settings, reach out to your workspace administrator — some sections have restricted access.</Note>