---
title: "Отримати угоду по ідентифікатору"
method: GET
path: "/agreements/{id}"
tags: ["Agreements"]
---

# Отримати угоду по ідентифікатору

`GET /agreements/{id}`

**Метод повертає дані по угоді.**

## Path parameters

- `id` integer, required

## Response `200`

Успішна відповідь

- Agreement — Дані угоди
  - `id` integer — Ідентифікатор
  - `title` string — Назва
  - `created_at` string — Дата та час створення
  - `updated_at` string — Дата та час оновлення
  - `marketplace_created_at` string — Дата та час створення на платформі (Rozetka/Prom/Allo/F.ua/Hubber/Хорошоп)
  - `total` number — Загальна сума
  - `comment` string — Коментар
  - `important` boolean — Важливо
  - `discount` number — Знижка
  - `discount_kind` 'percent_discount' | 'absolute_discount' — Тип знижки (відсоток чи сума)
  - `stage` object — Етап угоди
    - `name` string — Назва
  - `source` object — Джерело
    - `id` integer — Ідентифікатор
    - `name` string — Назва
  - `deliveries` DeliveryShort[] — Список доставки
    - `ttn` integer — Номер ТТН
    - `status_description` string — Опис статусу
    - `delivery_service_type` 'nova_poshta' | 'ukr_poshta' | 'justin' | 'manual' — Служба доставки
  - `result` 'archived' | 'successful' | 'failed' — Результат угоди (тільки для архівних угод)
  - `products_total_as_total` boolean — Сума товарів дорівнює сумі угоди
  - `client` Client — Дані клієнт/ліда
    - `id` integer — Ідентифікатор
    - `company` string — Назва компанії (якщо не заповнено, то буде взято значення ПІБ клієнта)
    - `person` string — ПІБ клієнта
    - `email` string — Email
    - `phones` string[] — Список телефонів
    - `lead` boolean — Це лід?
    - `important` boolean — Важливо
    - `comment` string — Коментар
    - `contractor_id` number — Ідентифікатор підрядника
    - `source` Source — Дані джерела
      - `id` number — Ідентифікатор
      - `name` string, required — Назва
      - `color` string — Колір
    - `main_responsible` User — Дані працівника (користувача)
      - `id` integer — Ідентифікатор
      - `name` string, required — Імʼя працівника
    - `tag_names` string[] — Теги
    - `custom_fields` CustomField[]
      - `name` string, required — Назва поля
      - `value` string, required — Значення поля
    - `contacts` Contact[]
      - `fullname` string, required — ПІБ
      - `email` string — Email
      - `phones` string[] — Список телефонів
      - `custom_fields` CustomField[]
        - `name` string, required — Назва поля
        - `value` string, required — Значення поля
  - `main_responsible` User — Дані працівника (користувача)
    - `id` integer — Ідентифікатор
    - `name` string, required — Імʼя працівника
  - `jobs` Job[]
    - `id` integer — Ідентифікатор
    - `title` string — Назва
    - `updated_at` string — Дата та час оновлення
    - `amount` number, required — Кількість
    - `discount` number — Знижка
    - `discount_kind` 'percent_discount' | 'absolute_discount' — Тип знижки (відсоток чи сума)
    - `cost` string — Собівартість товару з валютою (якщо включена мультивалютність "123.12", "$123.12")
    - `price` string, required — Ціна товару з валютою (якщо включена мультивалютність "123.12", "$123.12")
    - `total` string — Загальна сума товарів з валютою (якщо включена мультивалютність "123.12", "$123.12")
    - `custom_fields` CustomField[]
      - `name` string, required — Назва поля
      - `value` string, required — Значення поля
  - `custom_fields` object

## Other responses

- `401` — Невірний APIKey
- `404` — Не знайдено

---

[API](https://skmtc.dev/keepincrm/apis/keepincrm-api.md) · [All operations](https://skmtc.dev/keepincrm/apis/keepincrm-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/keepincrm/keepincrm-api/revisions/d0be1723749a/schema)
