mirror of
https://github.com/twentyhq/twenty.git
synced 2026-04-18 14:01:45 -04:00
183d034716
Reorganizing by Feature sections
Capabilities folders to give an overview of each feature
How-Tos folders to give guidance for advanced customizations
Reorganized the Developers section as well, moving the API sub section
there
added some new visuals and videos to illustrate the How-Tos articles
checked the typos, the links and added a section at the end of the
doc.json file to redirect existing links to the new ones (SEO purpose +
continuity of the user experience)
What I have not updated is the "l" folder that, per my understanding,
contains the translation of the User Guide - that I only edited in
English
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> <sup>[Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) is
generating a summary for commit
5301502a32. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: github-actions <github-actions@twenty.com>
Co-authored-by: Abdul Rahman <ar5438376@gmail.com>
Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
87 lines
3.9 KiB
Plaintext
87 lines
3.9 KiB
Plaintext
---
|
|
title: Objects
|
|
description: Learn about standard and custom objects in Twenty.
|
|
---
|
|
|
|
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
|
|
|
|
|
## Standard Objects
|
|
|
|
Standard objects are predefined entities in your workspace to help you get started. They're part of a shared data model accessible to all users of Twenty. You can use them as-is, customize them or deactivate them.
|
|
|
|
<img src="/images/user-guide/objects/standard-objects.png" style={{width:'100%'}}/>
|
|
|
|
### People
|
|
|
|
The `People` object stores your contacts. It includes contact details and interaction history, so you can see all your customer interactions in one place.
|
|
|
|
### Company
|
|
|
|
The `Companies` object stores your business accounts. It includes details like industry, size and location. Companies connect to both `People` and `Opportunities` objects.
|
|
|
|
### Opportunities
|
|
|
|
The `Opportunities` object stores deal-related data. It tracks the progression of potential sales, from prospecting to closure, recording stages, deal sizes, associated account, and expected close date. You can view your sales pipeline in a kanban layout.
|
|
|
|
### Notes
|
|
|
|
The `Notes` object stores free-form notes that can be attached to People, Companies, Opportunities, and other records. Use notes to capture meeting summaries, important details, or any contextual information.
|
|
|
|
### Tasks
|
|
|
|
The `Tasks` object stores to-dos and action items. Tasks can be linked to People, Companies, Opportunities, and other records. Track due dates, assignees, and completion status to stay on top of your follow-ups.
|
|
|
|
## Custom Objects
|
|
|
|
Custom objects let you store information that's unique to your organization and that standard objects can't handle. For example, if you're SpaceX, you may want to create a custom object for Rockets and Launches.
|
|
|
|
<img src="/images/user-guide/objects/custom-objects.png" style={{width:'100%'}}/>
|
|
|
|
### Creating a New Custom Object
|
|
|
|
To create a new custom object:
|
|
|
|
1. Go to Settings in the sidebar on the left.
|
|
2. Under Workspace, go to Data model. Here you'll be able to see an overview of all your existing Standard and Custom objects (both active and disabled).
|
|
|
|
<VimeoEmbed videoId="926288174" title="Video demonstration" />
|
|
|
|
3. Click on `+ New object` at the top. Enter the name (both singular and plural), choose an icon, and add a description for your custom object and hit Save (at the top right). Using Listing as an example of custom object, the singular would be "listing" and the plural would be "listings" along with a description like "Listings that hosts created to showcase their property."
|
|
|
|
|
|
4. Your custom object is now created and will appear in your sidebar. You can start adding records to it right away.
|
|
|
|
## Managing Objects
|
|
|
|
### Deactivating Objects
|
|
If you don't need a standard or custom object:
|
|
1. Go to Settings → Data Model
|
|
2. Find the object you want to deactivate
|
|
3. Click the toggle to deactivate it
|
|
4. The object will be hidden from your workspace but data is preserved
|
|
|
|
### Reactivating Objects
|
|
To bring back a deactivated object:
|
|
1. Go to Settings → Data Model
|
|
2. Look for deactivated objects (they'll be grayed out)
|
|
3. Click the toggle to reactivate it
|
|
4. The object and all its data will be restored
|
|
|
|
## Best Practices
|
|
|
|
### When to Create Custom Objects
|
|
- **Unique business entities**: Things specific to your industry or process
|
|
- **Complex relationships**: When you need to track connections between multiple entities
|
|
- **Scalable data**: When you might have many instances of something
|
|
|
|
### When to Use Fields Instead
|
|
- **Simple attributes**: Properties that describe existing objects
|
|
- **Categories or labels**: Ways to classify existing records
|
|
- **Single values**: Information that doesn't need its own lifecycle
|
|
|
|
### Object Naming
|
|
- **Use clear, descriptive names**: Make it obvious what the object represents
|
|
- **Follow conventions**: Use singular for the object name, plural for the collection
|
|
- **Consider your team**: Choose names everyone will understand
|