Pular para o conteúdo principal

Pesquisa

api_get_tasks_json

Obtém informações sobre as visitas realizadas no período especificado. É possível filtrar pelos IDs das tarefas e pelo ID do usuário.

Solicitação

Endpoint

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

Autenticação

Bearer Token (obrigatório)

Estrutura da solicitação

Cabeçalhos

Chave Valor
Authorization Bearer <token>
Content-Type application/json

Corpo da solicitação

{
  "function": "api_get_tasks_json",
  "format": "json",
  "arguments": {
    "date_from": "2025-08-04",
    "date_till": "2025-08-04",
    "ids": "1,2,3,4",
    "user_id": 1
  }
}
Campo Tipo Obrigatório Descrição
function string Sim Nome do método — "api_get_tasks_json"
format string Sim Formato da resposta — json
arguments object Sim Bloco de parâmetros
date_from string Sim Data inicial (YYYY-MM-DD)
date_till string Sim Data final (YYYY-MM-DD)
ids string Não Lista de IDs das visitas, separados por vírgulas
user_id integer Não ID do usuário do Proxima CRM

Resposta bem-sucedida

200 OK

json

Exemplo de resposta
[{"task_id":48313,
      "task_datefrom":"2025-08-01T12:30:00",
      "task_datetill":"2025-08-01T13:00:00",
      "task_gmt_offset":10800,
      "task_type":"Дзвінок лікарю",
      "task_user_id":38,
      "task_user2_id":38,
      "task_company_id":41016,
      "task_contact_id":36242,
      "task_target":[
         "Rx-Сімейний лікар"
      ],
      "task_spec":"Загальна практика - сімейна медицина (поликлиника)",
      "task_taskstate":"Виконаний",
      "task_created":"2025-07-05T22:47:51",
      "task_fact_start":"2025-08-01T11:20:15",
      "task_fact_end":"2025-08-01T13:27:14",
      "task_dist":null,
      "task_gps_lng":null,
      "task_gps_lat":null}]
Campo Descrição
task_id ID da visita no Proxima CRM
task_datefrom Data/hora prevista de início (UTC)
task_datetill Data/hora prevista de término (UTC)
task_gmt_offset Diferença com UTC (minutos)
task_type Tipo de visita
task_user_id ID do usuário executor
task_user2_id ID do observador / subordinado
task_company_id ID da instituição
task_contact_id ID do cliente
task_target Grupo-alvo da visita
task_spec Especialização do cliente
task_taskstate Status da visita
task_created Data/hora de criação
task_fact_start Início real
task_fact_end Fim real
task_dist Distância de fechamento
task_gps_lng Longitude
task_gps_lat Latitude

Erro

40x/50x

{
  "message": "string"
}
Código Descrição
400 Requisição inválida
401 Não autorizado
500 Erro interno do servidor