> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/twenty.md).

# Twenty

Twenty is an open-source CRM. Create people, companies, opportunities, tasks, and notes, search records for lookups, and watch for new records.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Twenty    | API Key        |

### Twenty

Connect to Twenty CRM with a workspace API key. Works with Twenty Cloud or a self-hosted Twenty server.

#### Set up in Twenty

1. Prepare the Twenty account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** In Twenty, open Settings > APIs & Webhooks and create a key. The key acts with the permissions of the role assigned to it.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Twenty**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                              |
| ------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes                      | In Twenty, open Settings > APIs & Webhooks and create a key. The key acts with the permissions of the role assigned to it. |
| Base URL      | Optional / as applicable | Leave the default for Twenty Cloud, or enter your self-hosted Twenty address, for example <https://crm.example.com>.       |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Twenty** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create Person

Add a person (contact) to Twenty, optionally linked to a company.

#### Inputs

| Field              | Type            | Required | Description                                                                                           |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| First Name         | string          | Yes      | The person's first name.                                                                              |
| Last Name          | string          | No       | The person's last name.                                                                               |
| Email              | string          | No       | Primary email address.                                                                                |
| Phone              | string          | No       | Primary phone number. Include the country code, e.g. +14155550100, unless you set Phone Country Code. |
| Job Title          | string          | No       | The person's role.                                                                                    |
| Company            | select (string) | No       | The company this person works at. Options load from the selected connection.                          |
| Phone Country Code | string          | No       | International calling code for the phone number.                                                      |
| LinkedIn URL       | string          | No       | Link to the person's LinkedIn profile.                                                                |

#### Outputs

| Field     | Type   | Description               |
| --------- | ------ | ------------------------- |
| Person    | object | The created person.       |
| Person ID | string | ID of the created person. |

### Create Company

Add a company to Twenty.

#### Inputs

| Field          | Type            | Required | Description                                                                                                                                                          |
| -------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Company Name   | string          | Yes      | The company's name.                                                                                                                                                  |
| Website        | string          | No       | The company's website.                                                                                                                                               |
| LinkedIn URL   | string          | No       | Link to the company's LinkedIn page.                                                                                                                                 |
| Annual Revenue | number          | No       | Yearly revenue in the chosen currency. Minimum: 0.                                                                                                                   |
| Currency       | select (string) | No       | Currency for the annual revenue. Available values: USD, EUR, GBP, JPY, CAD, AUD, CHF, CNY, HKD, SGD, SEK, NOK, DKK, NZD, INR, BRL, MXN, ZAR, AED, PLN. Default: USD. |
| Account Owner  | select (string) | No       | Teammate who owns this account. Options load from the selected connection.                                                                                           |
| City           | string          | No       | City of the company address.                                                                                                                                         |
| Country        | string          | No       | Country of the company address.                                                                                                                                      |

#### Outputs

| Field      | Type   | Description                |
| ---------- | ------ | -------------------------- |
| Company    | object | The created company.       |
| Company ID | string | ID of the created company. |

### Create Opportunity

Add a deal to Twenty's pipeline.

#### Inputs

| Field            | Type            | Required | Description                                                                                                                                                  |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Opportunity Name | string          | Yes      | A short name for the deal.                                                                                                                                   |
| Amount           | number          | No       | Deal value in the chosen currency. Minimum: 0.                                                                                                               |
| Currency         | select (string) | No       | Currency for the amount. Available values: USD, EUR, GBP, JPY, CAD, AUD, CHF, CNY, HKD, SGD, SEK, NOK, DKK, NZD, INR, BRL, MXN, ZAR, AED, PLN. Default: USD. |
| Stage            | select (string) | No       | Where the deal sits in the pipeline. Twenty uses New when empty. Available values: New, Screening, Meeting, Proposal, Customer.                              |
| Close Date       | date            | No       | When you expect the deal to close.                                                                                                                           |
| Company          | select (string) | No       | Company the deal is with. Options load from the selected connection.                                                                                         |
| Point of Contact | select (string) | No       | Main contact person for the deal. Options load from the selected connection.                                                                                 |
| Owner            | select (string) | No       | Teammate who owns the deal. Options load from the selected connection.                                                                                       |

#### Outputs

| Field          | Type   | Description                    |
| -------------- | ------ | ------------------------------ |
| Opportunity    | object | The created opportunity.       |
| Opportunity ID | string | ID of the created opportunity. |

### Create Task

Create a to-do in Twenty, optionally assigned and linked to a record.

#### Inputs

| Field         | Type            | Required | Description                                                                                          |
| ------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| Title         | string          | Yes      | What needs to be done.                                                                               |
| Details       | textarea        | No       | More detail about the task. Markdown works.                                                          |
| Status        | select (string) | No       | Task status. Twenty uses To do when empty. Available values: Todo, In Progress, Done.                |
| Due Date      | datetime        | No       | When the task is due.                                                                                |
| Assignee      | select (string) | No       | Teammate responsible for the task. Options load from the selected connection.                        |
| Link To       | select (string) | No       | Kind of record to attach the task to. Available values: Person, Company, Opportunity.                |
| Linked Record | select (string) | No       | Record to attach the task to. Pick the record type first. Options load from the selected connection. |

#### Outputs

| Field   | Type   | Description             |
| ------- | ------ | ----------------------- |
| Task    | object | The created task.       |
| Task ID | string | ID of the created task. |

### Create Note

Write a note in Twenty, optionally attached to a record.

#### Inputs

| Field         | Type            | Required | Description                                                                                          |
| ------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| Title         | string          | Yes      | Note heading.                                                                                        |
| Body          | textarea        | No       | Note content. Markdown works.                                                                        |
| Link To       | select (string) | No       | Kind of record to attach the note to. Available values: Person, Company, Opportunity.                |
| Linked Record | select (string) | No       | Record to attach the note to. Pick the record type first. Options load from the selected connection. |

#### Outputs

| Field   | Type   | Description             |
| ------- | ------ | ----------------------- |
| Note    | object | The created note.       |
| Note ID | string | ID of the created note. |

### Search People

Find people in Twenty by name or email.

#### Inputs

| Field         | Type            | Required | Description                                                              |
| ------------- | --------------- | -------- | ------------------------------------------------------------------------ |
| Name or Email | string          | No       | Text to look for in names and emails. Leave empty to list recent people. |
| Company       | select (string) | No       | Only people at this company. Options load from the selected connection.  |
| Max Results   | integer         | No       | Most people to return. Default: 20.                                      |
| Cursor        | string          | No       | Continue from a previous search.                                         |

#### Outputs

| Field       | Type          | Description                    |
| ----------- | ------------- | ------------------------------ |
| People      | object\_array | Matching people.               |
| Next Cursor | string        | Pass back to get more results. |

### Search Companies

Find companies in Twenty by name or website.

#### Inputs

| Field           | Type    | Required | Description                                                                           |
| --------------- | ------- | -------- | ------------------------------------------------------------------------------------- |
| Name or Website | string  | No       | Text to look for in company names and websites. Leave empty to list recent companies. |
| Max Results     | integer | No       | Most companies to return. Minimum: 1. Maximum: 100. Default: 20.                      |
| Cursor          | string  | No       | Continue from a previous search.                                                      |

#### Outputs

| Field       | Type          | Description                    |
| ----------- | ------------- | ------------------------------ |
| Companies   | object\_array | Matching companies.            |
| Next Cursor | string        | Pass back to get more results. |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Record

Polls Twenty on a schedule and fires for each person, company, opportunity, task, or note created since the last poll.

Polls Twenty roughly every 5 minutes and fires once for each new record of the record type you choose below.

#### Configuration

| Field       | Type            | Required | Description                                                                                |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------------------------ |
| Record Type | select (string) | Yes      | Which kind of record to watch. Available values: Person, Company, Opportunity, Task, Note. |

#### Event inputs

| Field       | Type   | Required | Description                                                      |
| ----------- | ------ | -------- | ---------------------------------------------------------------- |
| Record ID   | string | Yes      | ID of the new record. Default: .                                 |
| Record Type | string | Yes      | Kind of record. Default: .                                       |
| Name        | string | No       | Display name or title of the record.                             |
| Created At  | string | Yes      | When the record was created. Default: 0001-01-01 00:00:00+00:00. |
| Record      | object | Yes      | All fields of the new record. Default: {}.                       |

#### Outputs

| Field       | Type     | Description                          |
| ----------- | -------- | ------------------------------------ |
| Record ID   | string   | ID of the new record.                |
| Record Type | string   | Kind of record.                      |
| Name        | string   | Display name or title of the record. |
| Created At  | datetime | When the record was created.         |
| Record      | object   | All fields of the new record.        |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/twenty.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
