Довідники

Довідники повертають домени, типи й події таймлайна, які використовуються в ESG SaveEcoBot API.

Усі запити на цій сторінці не залежать від конкретного підприємства. Вони допомагають заздалегідь зрозуміти, які значення може приймати той чи інший параметр в інших запитах API.

Домени даних

GET /api/v1/dictionaries/data-domains

Цей запит повертає великі групи даних, які існують у ESG SaveEcoBot API.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/data-domains" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "slug": "air",
        "label": "Повітря"
      },
      {
        "slug": "water",
        "label": "Вода"
      },
      {
        "slug": "waste",
        "label": "Відходи"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

slug: технічний код домену, який використовується в URL і в параметрі domain у фільтрах довідників.
label: назва домену.

Типи повідомлень

GET /api/v1/dictionaries/notice-types

Цей запит повертає перелік типів повідомлень. Він потрібен для фільтрації повідомлень за параметром notice_type_id.

За потреби його можна обмежити конкретним доменом, наприклад air або water.

Фільтри

domain: технічний код домену, для якого потрібно повернути типи.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/notice-types?domain=air" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 3,
        "type_name": "Повідомлення про намір отримати дозвіл на викиди",
        "domain_slug": "air",
        "domain_label": "Повітря"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу повідомлення.
type_name: назва типу повідомлення.
domain_slug: технічний код домену, до якого належить тип повідомлення.
domain_label: назва домену.

Типи дозволів

GET /api/v1/dictionaries/permission-types

Цей запит повертає типи дозволів, ліцензій, декларацій та висновків, які використовуються в розділі дозволів. Він потрібен для фільтрації дозволів за параметром permission_type_id.

За потреби його можна обмежити певним доменом, наприклад air, water або food.

Фільтри

domain: технічний код домену, для якого потрібно повернути типи.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/permission-types?domain=air" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 1,
        "type_name": "Дозвіл на викиди забруднюючих речовин в атмосферне повітря",
        "domain_slug": "air",
        "domain_label": "Повітря"
      },
      {
        "id": 22,
        "type_name": "Декларації про провадження господарської діяльності в частині отримання дозволу на викиди забруднюючих речовин в атмосферне повітря стаціонарними джерелами",
        "domain_slug": "air",
        "domain_label": "Повітря"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу дозволу.
type_name: назва типу дозволу.
domain_slug: технічний код домену, до якого належить тип дозволу.
domain_label: назва домену.

Типи звітів

GET /api/v1/dictionaries/report-types

Цей запит дозволяє отримати перелік типів звітів, які можна використовувати в запитах по звітах. Він потрібен для фільтрації звітів за параметром report_type_id.

За потреби його можна обмежити конкретним доменом, наприклад air або water.

Фільтри

domain: технічний код домену, для якого потрібно повернути типи.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/report-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 2,
        "type_name": "Звіт про дотримання умов дозволу на викиди",
        "domain_slug": "air",
        "domain_label": "Повітря"
      },
      {
        "id": 3,
        "type_name": "Декларація про відходи",
        "domain_slug": "waste",
        "domain_label": "Відходи"
      },
      {
        "id": 1,
        "type_name": "Річний звіт про використання води в ДАВР",
        "domain_slug": "water",
        "domain_label": "Вода"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу звіту.
type_name: назва типу звіту.
domain_slug: технічний код домену, до якого належить тип звіту.
domain_label: назва домену.

Типи реєстрів

GET /api/v1/dictionaries/registry-types

Цей запит повертає перелік типів записів, які можуть з’являтися в різних реєстрах. Він потрібен для фільтрації записів реєстрів за параметром registry_type_id.

За потреби його можна обмежити конкретним доменом, наприклад air або water.

Фільтри

domain: технічний код домену, для якого потрібно повернути типи.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/registry-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 3,
        "type_name": "Реєстр об’єктів, які справляють шкідливий вплив",
        "domain_slug": "air",
        "domain_label": "Повітря"
      },
      {
        "id": 9,
        "type_name": "Державний реєстр потужностей операторів ринку",
        "domain_slug": "food",
        "domain_label": "Харчові продукти"
      },
      {
        "id": 12,
        "type_name": "Державний реєстр санкцій РНБО (юридичні особи)",
        "domain_slug": "sanctions",
        "domain_label": "Санкції"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу реєстру.
type_name: назва типу реєстру.
domain_slug: технічний код домену, до якого належить тип реєстру.
domain_label: назва домену.

Типи зобов’язань

GET /api/v1/dictionaries/obligation-types

Цей запит повертає перелік типів зобов’язань. Він потрібен для фільтрації зобов’язань за параметром obligation_type_id.

За потреби його можна обмежити конкретним доменом, наприклад air або water.

Фільтри

domain: технічний код домену, для якого потрібно повернути типи.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/obligation-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 1,
        "type_name": "Аграрна розписка",
        "domain_slug": "obligations",
        "domain_label": "Зобов’язання"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу зобов’язання.
type_name: назва типу зобов’язання.
domain_slug: технічний код домену, до якого належить тип зобов’язання.
domain_label: назва домену.

Типи сертифікатів

GET /api/v1/dictionaries/certificate-types

Цей запит повертає перелік типів сертифікатів, посвідчень і свідоцтв, які використовуються в розділі сертифікатів. Він потрібен для фільтрації сертифікатів за параметром certificate_type_id.

За потреби його можна обмежити конкретним доменом, наприклад agro або forest.

Фільтри

domain: технічний код домену, для якого потрібно повернути типи.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/certificate-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 1,
        "type_name": "Сертифікат про походження лісоматеріалів та виготовлених з них пиломатеріалів",
        "domain_slug": "forest",
        "domain_label": "Ліси"
      },
      {
        "id": 3,
        "type_name": "Посвідчення на право роботи з пестицидами",
        "domain_slug": "agro",
        "domain_label": "Агро"
      },
      {
        "id": 2,
        "type_name": "Свідоцтво про належність палива до альтернативного",
        "domain_slug": "energy",
        "domain_label": "Енергетика"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу сертифіката.
type_name: назва типу сертифіката.
domain_slug: технічний код домену, до якого належить тип сертифіката.
domain_label: назва домену.

Типи скарг

GET /api/v1/dictionaries/complaint-types

Цей запит повертає перелік типів скарг. Він потрібен для фільтрації скарг за параметром complaint_type_id.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/complaint-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 2,
        "type_name": "Екологічна скарга"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу скарги.
type_name: назва типу скарги.

Типи інспекційних перевірок

GET /api/v1/dictionaries/inspection-super-types

Цей запит повертає перелік типів інспекційних перевірок. Він потрібен для фільтрації перевірок за параметром super_type_id.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/inspection-super-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 1,
        "type_name": "Екологічні"
      },
      {
        "id": 2,
        "type_name": "Санітарні"
      },
      {
        "id": 3,
        "type_name": "Енергетичні"
      },
      {
        "id": 4,
        "type_name": "Інші"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу перевірки.
type_name: назва типу перевірки.

Типи документів ОВД

GET /api/v1/dictionaries/eia-document-types

Цей запит повертає типи документів, які використовуються в розділі ОВД. Він потрібен для фільтрації документів ОВД за параметром document_type_id.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/eia-document-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 1,
        "type_name": "Оголошення про плановану діяльність"
      },
      {
        "id": 4,
        "type_name": "Звіт з оцінки впливу на довкілля"
      },
      {
        "id": 10,
        "type_name": "Висновок з оцінки впливу на довкілля"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу документа ОВД.
type_name: назва типу документа ОВД.

Типи документів СЕО

GET /api/v1/dictionaries/sea-document-types

Цей запит повертає типи документів, які використовуються в розділі СЕО. Він потрібен для фільтрації документів СЕО за параметром document_type_id.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/sea-document-types" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "id": 1,
        "type_name": "Заява про визначення обсягу стратегічної екологічної оцінки"
      },
      {
        "id": 7,
        "type_name": "Звіт про стратегічну екологічну оцінку"
      },
      {
        "id": 15,
        "type_name": "Затверджений документ державного планування"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

id: ідентифікатор типу документа СЕО.
type_name: назва типу документа СЕО.

Події таймлайна

GET /api/v1/dictionaries/timeline-events

Цей запит повертає перелік технічних кодів подій таймлайна. Він потрібен для фільтрації таймлайна за параметром event.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/dictionaries/timeline-events" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "items": [
      {
        "event": "created_permission",
        "label": "Дозвіл",
        "resource": "permission"
      },
      {
        "event": "created_permission_file",
        "label": "Файл дозволу",
        "resource": "permission_file",
        "parent_resource": "permission"
      },
      {
        "event": "created_court_case",
        "label": "Екосудова справа",
        "resource": "court_case"
      }
    ]
  },
  "stats": { "request_id": "crm-sync-2026-05-14-001", "response_time_ms": 43 }
}

Поля відповіді

`results.items[]`

event: технічний код події.
label: коротка людська назва події.
resource: технічний код основного ресурсу, який пов'язаний із подією, наприклад report, permission_file, registry, court_case.
parent_resource: технічний код батьківського ресурсу, якщо подія пов'язана з вкладеним об'єктом, наприклад permission, registry, eia_case.

Домени даних

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи повідомлень

Фільтри

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи дозволів

Фільтри

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи звітів

Фільтри

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи реєстрів

Фільтри

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи зобов’язань

Фільтри

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи сертифікатів

Фільтри

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи скарг

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи інспекційних перевірок

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи документів ОВД

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Типи документів СЕО

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Події таймлайна

Приклад запиту

Приклад відповіді

Поля відповіді

results.items[]

Візьміть участь в тестуванні ESG профілю підприємства у системі SaveEcoBot

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`

`results.items[]`