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.
API с отдельной схемой для каждого тенанта
Для Twenty нет статической документации по API. У каждого рабочего пространства своя схема — когда вы добавляете пользовательский объект (например,Invoice), он сразу получает эндпоинты REST и GraphQL, идентичные встроенным объектам, таким как Company или Person. API генерируется из схемы, поэтому эндпоинты напрямую используют названия ваших объектов и полей — никаких непрозрачных идентификаторов.
Документация по API для вашего рабочего пространства доступна в разделе Настройки → API и вебхуки после создания ключа API. Она включает интерактивную песочницу, где вы можете выполнять реальные вызовы к своим данным.
Два API
Основное API —/rest/ и /graphql/
CRUD над записями: Люди, Компании, Сделки, ваши пользовательские объекты. Запросы, фильтрация, переход по связям.
API метаданных — /rest/metadata/ и /metadata/
Управление схемой: создание/изменение/удаление объектов, полей и связей. Так вы программно изменяете свою модель данных.
Оба доступны как REST и GraphQL. GraphQL добавляет пакетные upsert-операции и возможность переходить по связям в одном запросе. В обоих случаях используются одни и те же базовые данные.
Базовые URL-адреса
| Среда | Базовый URL |
|---|---|
| Облако | https://api.twenty.com/ |
| Самостоятельный хостинг | https://{your-domain}/ |
Аутентификация
Пакетные операции
И REST, и GraphQL поддерживают пакетную обработку до 60 записей за один запрос — создание, обновление или удаление. GraphQL также поддерживает пакетный upsert (создание или обновление за один вызов), используя имена во множественном числе, напримерCreateCompanies.
Лимиты скорости
| Лимит | Значение |
|---|---|
| Запросы | 100 запросов в минуту |
| Размер пакета | 60 записей за один запрос |