> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Twenty

> The #1 Open-Source CRM. Modern, powerful, affordable platform to manage your customer relationships.

![Twenty logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/twenty.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=22c3bcfafeacd113083900d896a19186)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `TWENTY`
* **Version:** 00000000\_00

## Tools

> [accordion] Batch Create CRM Records
>
> **Slug:** `TWENTY_BATCH_CREATE_RECORDS`
>
> Create 1-60 records of one type. Supported standard fields: companies (name, domainName, linkedinLink, annualRevenue, address, accountOwnerId); people (name, emails, linkedinLink, jobTitle, phones, avatarUrl, companyId); opportunities (name, amount, closeDate, stage, companyId, pointOfContactId, ownerId); tasks (title, bodyV2, dueAt, status, assigneeId). Custom fields, workspace-specific enum variants, and upsert are not supported.
>
> #### Input Parameters
>
> **records** `array` *required*
>
> One to 60 records for the selected type. Unknown fields, composite keys, and fields belonging to another record type are rejected.
>
> **object\_type** `string ("companies" | "people" | "opportunities" | "tasks")` *required*
>
> CRM record type to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Attached Note
>
> **Slug:** `TWENTY_CREATE_ATTACHED_NOTE`
>
> Create a note and attach it to one company, person, or opportunity. If attachment creation fails, the newly created note is deleted on a best-effort basis.
>
> #### Input Parameters
>
> **title** `string`
>
> Optional title for the new note.
>
> **target\_id** `string` *required*
>
> UUID of the company, person, or opportunity receiving the note. Use an ID returned by the corresponding TWENTY\_LIST\_RECORDS or TWENTY\_GET\_RECORD action.
>
> **target\_type** `string ("company" | "person" | "opportunity")` *required*
>
> Type of CRM record to attach the note to: company, person, or opportunity.
>
> **body\_markdown** `string`
>
> Optional Markdown content for the note body. An empty string creates an empty body.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Object Record
>
> **Slug:** `TWENTY_CREATE_CUSTOM_RECORD`
>
> Create one record in a workspace-defined custom object using its plural API name and arbitrary schema-discovered fields.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for the created record only or 1 to include direct relations.
>
> **fields** `string`
>
> Comma-separated API field names to include in the returned record.
>
> **record** `object` *required*
>
> Non-empty JSON object whose keys are API field names from the custom object schema and whose values are the record values to create.
>
> **object\_name\_plural** `string` *required*
>
> Plural API name of the workspace-defined object, as returned by Twenty object metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create CRM Record
>
> **Slug:** `TWENTY_CREATE_RECORD`
>
> Create one company, person, opportunity, or task using the supported standard fields in the parameter schema. Custom fields and workspace-specific enum variants are not supported.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for the created record only or 1 to include direct relations.
>
> **record** `string` *required*
>
> Fields for the selected record type. Unknown fields, composite keys, and fields belonging to another record type are rejected.
>
> **object\_type** `string ("companies" | "people" | "opportunities" | "tasks")` *required*
>
> CRM record type to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete CRM Record
>
> **Slug:** `TWENTY_DELETE_RECORD`
>
> Permanently delete one company, person, opportunity, or task by UUID. Use only for a specifically identified record; this does not delete by filter or in bulk.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Exact UUID of the record to permanently delete. Confirm it with Get CRM Record first.
>
> **object\_type** `string ("companies" | "people" | "opportunities" | "tasks")` *required*
>
> CRM record type containing the record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Object Record
>
> **Slug:** `TWENTY_GET_CUSTOM_RECORD`
>
> Get one record from a workspace-defined custom object by UUID using the object's plural API name from List CRM Objects.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for the primary record only or 1 to include direct relations.
>
> **fields** `string`
>
> Comma-separated API field names to include in the returned record.
>
> **record\_id** `string` *required*
>
> UUID of the custom-object record to retrieve.
>
> **object\_name\_plural** `string` *required*
>
> Path-safe plural API name from List CRM Objects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get CRM Record
>
> **Slug:** `TWENTY_GET_RECORD`
>
> Get one company, person, opportunity, or task by its Twenty UUID, optionally including direct relations.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for the primary record only or 1 to include direct relations.
>
> **record\_id** `string` *required*
>
> Twenty record UUID, usually obtained from List CRM Records or Create CRM Record.
>
> **object\_type** `string ("companies" | "people" | "opportunities" | "tasks")` *required*
>
> CRM record type containing the record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Object Records
>
> **Slug:** `TWENTY_LIST_CUSTOM_RECORDS`
>
> List records from a workspace-defined custom object using its plural API name, with Twenty filtering, ordering, relation depth, and cursor pagination.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for primary records only or 1 to include direct relations.
>
> **limit** `integer`
>
> Maximum custom records to return in this page (0-200).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
>
> **fields** `string`
>
> Comma-separated fields to include in each returned custom record.
>
> **filter** `string`
>
> Twenty filter expression, for example name\[ilike]:"%acme%". Use List CRM Fields to confirm custom field names and types.
>
> **order\_by** `string`
>
> Twenty ordering expression, for example createdAt\[DescNullsLast].
>
> **object\_name\_plural** `string` *required*
>
> Plural API name of a custom object, as returned by List CRM Objects. This is a case-sensitive lower-camel identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Fields
>
> **Slug:** `TWENTY_LIST_FIELDS`
>
> List field definitions from the connected Twenty workspace to discover exact field names, types, editability, nullability, uniqueness, and relation targets for schema inspection and filters. Record writes accept only fields exposed by the Create or Update CRM Record parameter schema.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum field definitions to return in this page (1-200).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Note Targets
>
> **Slug:** `TWENTY_LIST_NOTE_TARGETS`
>
> List associations between notes and companies, people, or opportunities with Twenty filtering, ordering, relation depth, and cursor pagination.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for association fields only or 1 to include direct relations.
>
> **limit** `integer`
>
> Maximum note-target associations to return in this page (0-200).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
>
> **fields** `string`
>
> Comma-separated fields to include in each note-target association.
>
> **filter** `string`
>
> Twenty filter expression, for example noteId\[eq]:"\<note-id>" or targetPersonId\[eq]:"\<person-id>".
>
> **order\_by** `string`
>
> Twenty ordering expression, for example createdAt\[DescNullsLast].
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Objects
>
> **Slug:** `TWENTY_LIST_OBJECTS`
>
> List standard and custom object definitions in the connected Twenty workspace for schema inspection. Record tools currently support only companies, people, opportunities, and tasks.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum object definitions to return in this page (1-200).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Records
>
> **Slug:** `TWENTY_LIST_RECORDS`
>
> List companies, people, opportunities, or tasks with Twenty filter syntax, ordering, relation depth, and forward cursor pagination.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for primary records only or 1 to include direct relations.
>
> **limit** `integer`
>
> Maximum records to return in this page (1-60).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged; never pass the literal string null.
>
> **filter** `string`
>
> Twenty filter expression, for example name\[ilike]:"%acme%" or status\[eq]:"IN\_PROGRESS". Use List CRM Fields to confirm field names and types.
>
> **order\_by** `string`
>
> Twenty ordering expression, for example createdAt\[DescNullsLast].
>
> **object\_type** `string ("companies" | "people" | "opportunities" | "tasks")` *required*
>
> CRM record type to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Task Targets
>
> **Slug:** `TWENTY_LIST_TASK_TARGETS`
>
> List associations between tasks and companies, people, or opportunities with Twenty filtering, ordering, relation depth, and cursor pagination.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for association fields only or 1 to include direct relations.
>
> **limit** `integer`
>
> Maximum task-target associations to return in this page (0-200).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
>
> **fields** `string`
>
> Comma-separated fields to include in each task-target association.
>
> **filter** `string`
>
> Twenty filter expression, for example taskId\[eq]:"\<task-id>" or targetCompanyId\[eq]:"\<company-id>".
>
> **order\_by** `string`
>
> Twenty ordering expression, for example createdAt\[DescNullsLast].
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workspace Members
>
> **Slug:** `TWENTY_LIST_WORKSPACE_MEMBERS`
>
> List Twenty workspace members for identity and assignment lookups, with filtering, ordering, relation depth, and cursor pagination.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for member fields only or 1 to include direct relations.
>
> **limit** `integer`
>
> Maximum workspace members to return in this page (0-200).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
>
> **fields** `string`
>
> Comma-separated fields to include in each workspace member.
>
> **filter** `string`
>
> Twenty filter expression, for example userEmail\[eq]:"[user@example.com](mailto:user@example.com)".
>
> **order\_by** `string`
>
> Twenty ordering expression, for example createdAt\[DescNullsLast].
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Object Record
>
> **Slug:** `TWENTY_UPDATE_CUSTOM_RECORD`
>
> Partially update one record in a workspace-defined custom object by UUID. Use the object's plural API name and field API names from Twenty metadata.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for the updated record only or 1 to include direct relations.
>
> **fields** `string`
>
> Comma-separated API field names to include in the returned record.
>
> **changes** `object` *required*
>
> Non-empty partial update keyed by field API name. Only these supplied fields are changed.
>
> **record\_id** `string` *required*
>
> UUID of the custom-object record to update.
>
> **object\_name\_plural** `string` *required*
>
> Plural API name of the custom object from Twenty object metadata, such as invoices or billingSchedules.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update CRM Record
>
> **Slug:** `TWENTY_UPDATE_RECORD`
>
> Partially update one company, person, opportunity, or task by UUID using the supported standard fields in the parameter schema; only supplied fields change. Custom fields and workspace-specific enum variants are not supported.
>
> #### Input Parameters
>
> **depth** `integer ("0" | "1")`
>
> Use 0 for the updated record only or 1 to include direct relations.
>
> **changes** `string` *required*
>
> Non-empty partial record for the selected type. Unknown fields, nested composite keys, and fields belonging to another record type are rejected.
>
> **record\_id** `string` *required*
>
> UUID of the record to update.
>
> **object\_type** `string ("companies" | "people" | "opportunities" | "tasks")` *required*
>
> CRM record type containing the record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
