Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

A Twenty app’s data layer is the data your app adds to a workspace — the new record types it declares, the columns it adds to existing objects, and how those records connect to each other. 
┌──────────────────────────────────────────────────┐
│ Object — a record type, e.g. PostCard            │
│    ├─ Field     (name, type, label)              │
│    ├─ Field                                      │
│    └─ Relation  (link to another object)         │
└──────────────────────────────────────────────────┘
            │
            ├── lives in your app, OR
            │
            ▼
┌──────────────────────────────────────────────────┐
│ Standard / other apps' objects                   │
│    └─ Field added by your app via defineField    │
└──────────────────────────────────────────────────┘

​
In this section

Objects

defineObject — declare new record types with their own fields.

Extending Objects

defineField — add fields to standard or other apps’ objects.

Relations

Bidirectional MANY_TO_ONE / ONE_TO_MANY connections between objects.

​
Entities at a glance

EntityPurposeDefined with
ObjectA new custom record type (e.g. PostCard, Invoice) with its own fieldsdefineObject()
FieldA column on an object. Standalone fields can extend objects you didn’t create (e.g. add loyaltyTier to Company)defineField()
RelationA bidirectional link between two objects — both sides declared as fieldsdefineField() with FieldType.RELATION
The SDK detects these via AST analysis at build time, so file organization is up to you — the convention is src/objects/ and src/fields/. Stable universalIdentifier UUIDs tie everything together across deploys.
Looking for Application Config or Roles & Permissions? Those describe the app itself rather than the data it adds — they live under Config. Looking for Connections (Linear, GitHub, Slack OAuth)? Those exist to be called from logic functions and live under Logic.