api_get_tasks – Proxima Research Brazil

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",
  "format": "csv",
  "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"
format	string	Sim	Formato da resposta — csv
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

Formato csv — resposta retornada como texto simples.

Content-Type

text/plain

Exemplo de resposta

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

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

Pesquisa