---
title: API
image: /images/docs/getting-started/api.png
info: Дізнайтеся, як використовувати наші API.
---

<Frame>
  <img src="/images/docs/getting-started/api.png" alt="Header" />
</Frame>

## Огляд

The Twenty API allows developers to interact programmatically with the Twenty CRM platform. Використовуючи API, ви можете інтегрувати Twenty з іншими системами, автоматизувати синхронізацію даних та створювати власні рішення навколо ваших клієнтських даних. API надає кінцеві точки для **створення, читання, оновлення та видалення** основних об'єктів CRM (таких як люди та компанії), а також доступ до налаштувань метаданих.

**API Playground:**  You can now access the API Playground within the app's settings. Щоб спробувати виклики API у реальному часі, ввійдіть у вашу робочу область Twenty і перейдіть до **Налаштування → API та Webhooks**. This opens the in-app API Playground and the settings for API keys.
**[Перейти до налаштувань API](https://app.twenty.com/settings)**

## Аутентифікація

API Twenty використовує ключі API для аутентифікації. Кожен запит до захищених кінцевих точок повинен включати ключ API в заголовок.

- **Ключі API:** Ви можете створити новий ключ API на сторінці ваших налаштувань **API** додатку Twenty. Кожен ключ API є секретним токеном, який надає доступ до ваших даних CRM, тому зберігайте його в безпеці. Якщо ключ скомпрометовано, вилучіть його з налаштувань і створіть новий.
- **Заголовок Аутентифікації:** Після отримання ключа API включіть його в заголовок `Authorization` ваших HTTP запитів. Використовуйте схему Bearer токен. Наприклад:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```

  Замініть `YOUR_API_KEY` на ключ, який ви отримали. Цей заголовок повинен бути присутнім у **всіх запитах API**. Якщо токен відсутній або недійсний, API відповість помилкою аутентифікації (HTTP 401 Unauthorized).

## Кінцеві точки API

Всі ресурси можуть бути доступні через REST або GraphQL.

- **Хмара:** `https://api.twenty.com/` або ваш користувацький домен / субдомен
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).

Кінцеві точки поділяються на дві категорії: **Основний API** та **API метаданих**. **Основний API** стосується основних даних CRM (наприклад, люди, компанії, нотатки, завдання), тоді як **API метаданих** охоплює дані налаштувань (наприклад, налаштовані поля або визначення об'єктів). Більшість інтеграцій, як правило, використовують Основний API.

### Основний API

Доступний на `/rest/` або `/graphql/`.
**Основний API** служить єдиним інтерфейсом для управління основними сутностями CRM (людей, компаній, нотаток, завдань) та їх відносинами, пропонуючи моделі взаємодії **як REST, так і GraphQL**.

### API метаданих

Доступний на `/rest/metadata/` або `/metadata/`.
Кінцеві точки API метаданих дозволяють отримати інформацію про вашу схему та налаштування. Наприклад, ви можете отримати визначення користувацьких полів, схем об'єктів тощо.

- **Example Endpoints:**

  - `GET /rest/metadata/objects` – Перелік всіх типів об'єктів та їх метаданих (поля, відносини).
  - `GET /rest/metadata/objects/{objectName}` – Отримайте метадані для певного об'єкта (наприклад, `люди`, `компанії`).
  - `GET /rest/metadata/picklists` – Отримайте опції полів випадаючих списків, визначені у CRM.

Зазвичай кінцеві точки метаданих використовуються для розуміння структури даних (для динамічних інтеграцій або створення форм), а не для управління записами. Вони в більшості випадків мають режим лише для читання. Для їх використання також потрібно аутентифікацію (використовуйте ваш API ключ).