Twnenty API

Twenty offers APIs in REST and GraphQL.

• Use the Metadata API for anything related to your workspace and its data model.
• Use the Core API for anything related to your records.

Your unique APIs

Unique APIs are generated for your workspace, to perfectly reflect your custom data model.
This means you will have a dedicated endpoint for each of your custom objects and custom fields -- which will make the dev experience much nicer!

Benefits of the GraphQL APIs

• Batch operations are available with the GraphQL APIs. You just need to use the plural name of your object.
  Example: use the mutation CreateCompanies instead of CreateCompany for your batch creation. (This is the reason why the singular and plural names of your object needs to be distinct.)

• Upsert option is available with the GraphQL APIs.

API Documentation

Twenty API documentation is accessible under your workspace Settings -> API. As unique APIs are generated to perfectly reflect your data model, Twenty creates customized API documentation. This is why you need to input an API key to access it.
You will also find a playground where you can test the APIs and the data returned.

API Keys

API keys allow automated access to your CRM data, synchronize data with other systems, and create custom integrations or solutions.

For example, you can use them to retrieve details of a specific Person or Company record, such as their name or address.

Generate an API key

1. Go to Settings in the sidebar on the left.
2. In the bottom left, activate "Advanced mode." A new section for API & Webhooks will appear.
3. To generate a new key, click on + Create key at the top right.
4. Give your API key a name, an expiration date, and a logo.
5. Hit save to see your API key.
6. Since the key is only visible once, make sure you store it somewhere safe.

Regenerating an API key

To regenerate an API key, click on the key you want to regenerate. You'll then be able to see a button to regenerate the API key.

Webhooks

Webhooks allow for immediate updates to your specified URL about changes or events related to your customer data.

For instance, a webhook can alert your system in real-time when someone creates a new person record or updates an existing note.

Creating Webhooks

1. From Settings -> Developers, click + Create webhook.
2. Enter your URL.
3. Click Save.

Deleting Webhooks

1. In Developers, find your webhook.
2. Click on your webhook and press Delete to remove it. A confirmation popup will appear to confirm.