api_get_tasks – Proxima Research Ukraine

Отримує інформацію про візити за вказаний період часу. Підтримується фільтрація за по ID задач та ID користувача.

Запит

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

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

Bearer Token (обов'язковий)

Структура запиту

Заголовки

Ключ	Значення
Authorization	Bearer `<token>`
Content-Type	application/json

Тіло запиту

{
  "function": "api_get_tasks",
  "format": "csv",
  "arguments": {
    "date_from": "2025-08-04",
    "date_till": "2025-08-04",
    "ids": "1,2,3,4",
    "user_id": 1
  }
}

Поле	Тип	Обов'язковий	Опис
function	string	Так	Ім’я API методу. Для цього запиту — "api_get_tasks"
format	string	Так	Формат відповіді - csv
arguments	object	Так	Необов’язкові аргументи, специфічні для методу
date_from	string	Так	Дата початку формування списку візитів. Формат: `YYYY-MM-DD`
date_till	string	Так	Дата завершення формування списку. Формат: `YYYY-MM-DD`
ids	string	Ні	Список ID клієнтів через кому. Якщо не вказано, повертаються всі відвідані клієнти
user_id	integer	Ні	Ідентифікатор користувача з Proxima CRM. Повертає візити для конкретного користувача.

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

200 OK

Формат "csv": відповідь у вигляді тексту CSV.

Content-Type

text/plain

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

task_id,task_datefrom,task_datetill,task_gmt_offset,task_type,task_user_id,task_user2_id,task_company_id,task_contact_id,task_target,task_spec,task_taskstate,task_created,task_fact_start,task_fact_end,task_dist,task_gps_lng,task_gps_lat
1234,2025-08-04T08:00:00Z,2025-08-04T08:30:00Z,180,Visit,5,,101,201,A,Cardiologist,Done,2025-08-03T12:15:00Z,2025-08-04T08:03:00Z,2025-08-04T08:28:00Z,0.5,30.5238,50.4501

Поле	Опис
task_id	Ідентифікатор візиту в базі даних Proxima CRM
task_datefrom	Дата й час запланованого початку візиту (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_datetill	Дата й час запланованого завершення візиту (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_gmt_offset	Зміщення від UTC у хвилинах
task_type	Тип візиту
task_user_id	Ідентифікатор виконавця (користувача) з Proxima CRM
task_user2_id	Ідентифікатор спостерігача/підлеглого (якщо є)
task_company_id	Ідентифікатор установи в Proxima CRM
task_contact_id	Ідентифікатор клієнта в Proxima CRM
task_target	Таргет-група візиту
task_spec	Спеціалізація клієнта, зазначена під час візиту
task_taskstate	Статус візиту (наприклад, Запланований, Завершений, Скасований)
task_created	Дата й час створення завдання (UTC). Формат: YYYY-MM-DD HH:MM:SS
task_fact_start	Фактичний час початку візиту (UTC)
task_fact_end	Фактичний час завершення візиту (UTC)
task_dist	Відстань закриття візиту (у км або метрах, залежно від налаштувань)
task_gps_lng	Довгота координати закриття візиту
task_gps_lat	Широта координати закриття візиту

Помилкова відповідь

40x/50x

{
  "message": "string"
}

Код	Опис
400	Невірний запит (наприклад, відсутні обов'язкові параметри)
401	Неавторизовано (недійсний або відсутній токен)
500	Внутрішня помилка сервера

Пошук