Skip to main content
Twenty logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: TWENTY
  • Version: 00000000_00

Tools

Slug: TWENTY_BATCH_CREATE_RECORDSCreate 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

array
required
One to 60 records for the selected type. Unknown fields, composite keys, and fields belonging to another record type are rejected.
string ("companies" | "people" | "opportunities" | "tasks")
required
CRM record type to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_CREATE_ATTACHED_NOTECreate 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

string
Optional title for the new note.
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.
string ("company" | "person" | "opportunity")
required
Type of CRM record to attach the note to: company, person, or opportunity.
string
Optional Markdown content for the note body. An empty string creates an empty body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_CREATE_CUSTOM_RECORDCreate one record in a workspace-defined custom object using its plural API name and arbitrary schema-discovered fields.

Input Parameters

integer ("0" | "1")
Use 0 for the created record only or 1 to include direct relations.
string
Comma-separated API field names to include in the returned 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.
string
required
Plural API name of the workspace-defined object, as returned by Twenty object metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_CREATE_RECORDCreate 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

integer ("0" | "1")
Use 0 for the created record only or 1 to include direct relations.
string
required
Fields for the selected record type. Unknown fields, composite keys, and fields belonging to another record type are rejected.
string ("companies" | "people" | "opportunities" | "tasks")
required
CRM record type to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_DELETE_RECORDPermanently 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

string
required
Exact UUID of the record to permanently delete. Confirm it with Get CRM Record first.
string ("companies" | "people" | "opportunities" | "tasks")
required
CRM record type containing the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_GET_CUSTOM_RECORDGet one record from a workspace-defined custom object by UUID using the object’s plural API name from List CRM Objects.

Input Parameters

integer ("0" | "1")
Use 0 for the primary record only or 1 to include direct relations.
string
Comma-separated API field names to include in the returned record.
string
required
UUID of the custom-object record to retrieve.
string
required
Path-safe plural API name from List CRM Objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_GET_RECORDGet one company, person, opportunity, or task by its Twenty UUID, optionally including direct relations.

Input Parameters

integer ("0" | "1")
Use 0 for the primary record only or 1 to include direct relations.
string
required
Twenty record UUID, usually obtained from List CRM Records or Create CRM Record.
string ("companies" | "people" | "opportunities" | "tasks")
required
CRM record type containing the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_LIST_CUSTOM_RECORDSList records from a workspace-defined custom object using its plural API name, with Twenty filtering, ordering, relation depth, and cursor pagination.

Input Parameters

integer ("0" | "1")
Use 0 for primary records only or 1 to include direct relations.
integer
Maximum custom records to return in this page (0-200).
string
Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
string
Comma-separated fields to include in each returned custom record.
string
Twenty filter expression, for example name[ilike]:“%acme%”. Use List CRM Fields to confirm custom field names and types.
string
Twenty ordering expression, for example createdAt[DescNullsLast].
string
required
Plural API name of a custom object, as returned by List CRM Objects. This is a case-sensitive lower-camel identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_LIST_FIELDSList 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

integer
Maximum field definitions to return in this page (1-200).
string
Opaque next cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_LIST_NOTE_TARGETSList associations between notes and companies, people, or opportunities with Twenty filtering, ordering, relation depth, and cursor pagination.

Input Parameters

integer ("0" | "1")
Use 0 for association fields only or 1 to include direct relations.
integer
Maximum note-target associations to return in this page (0-200).
string
Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
string
Comma-separated fields to include in each note-target association.
string
Twenty filter expression, for example noteId[eq]:“<note-id>” or targetPersonId[eq]:“<person-id>”.
string
Twenty ordering expression, for example createdAt[DescNullsLast].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_LIST_OBJECTSList 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

integer
Maximum object definitions to return in this page (1-200).
string
Opaque next cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_LIST_RECORDSList companies, people, opportunities, or tasks with Twenty filter syntax, ordering, relation depth, and forward cursor pagination.

Input Parameters

integer ("0" | "1")
Use 0 for primary records only or 1 to include direct relations.
integer
Maximum records to return in this page (1-60).
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.
string
Twenty filter expression, for example name[ilike]:“%acme%” or status[eq]:“IN_PROGRESS”. Use List CRM Fields to confirm field names and types.
string
Twenty ordering expression, for example createdAt[DescNullsLast].
string ("companies" | "people" | "opportunities" | "tasks")
required
CRM record type to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_LIST_TASK_TARGETSList associations between tasks and companies, people, or opportunities with Twenty filtering, ordering, relation depth, and cursor pagination.

Input Parameters

integer ("0" | "1")
Use 0 for association fields only or 1 to include direct relations.
integer
Maximum task-target associations to return in this page (0-200).
string
Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
string
Comma-separated fields to include in each task-target association.
string
Twenty filter expression, for example taskId[eq]:“<task-id>” or targetCompanyId[eq]:“<company-id>”.
string
Twenty ordering expression, for example createdAt[DescNullsLast].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_LIST_WORKSPACE_MEMBERSList Twenty workspace members for identity and assignment lookups, with filtering, ordering, relation depth, and cursor pagination.

Input Parameters

integer ("0" | "1")
Use 0 for member fields only or 1 to include direct relations.
integer
Maximum workspace members to return in this page (0-200).
string
Opaque next cursor from a previous response. Omit for the first page and pass a returned cursor back unchanged.
string
Comma-separated fields to include in each workspace member.
string
Twenty filter expression, for example userEmail[eq]:“user@example.com”.
string
Twenty ordering expression, for example createdAt[DescNullsLast].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_UPDATE_CUSTOM_RECORDPartially 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

integer ("0" | "1")
Use 0 for the updated record only or 1 to include direct relations.
string
Comma-separated API field names to include in the returned record.
object
required
Non-empty partial update keyed by field API name. Only these supplied fields are changed.
string
required
UUID of the custom-object record to update.
string
required
Plural API name of the custom object from Twenty object metadata, such as invoices or billingSchedules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWENTY_UPDATE_RECORDPartially 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

integer ("0" | "1")
Use 0 for the updated record only or 1 to include direct relations.
string
required
Non-empty partial record for the selected type. Unknown fields, nested composite keys, and fields belonging to another record type are rejected.
string
required
UUID of the record to update.
string ("companies" | "people" | "opportunities" | "tasks")
required
CRM record type containing the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not