api_get_actions – Proxima Research Brazil

Retorna informações sobre atividades não relacionadas a visitas (tarefas) para o 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_actions",
  "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 da API. Para esta requisição — "api_get_actions".
format	string	Sim	Formato da resposta — csv
arguments	object	Sim	Bloco de parâmetros
date_from	string	Sim	Data de início do período de relatório (pela data de início da atividade). Formato: YYYY-MM-DD
date_till	string	Sim	Data de término do período de relatório (pela data de conclusão da atividade). Formato: YYYY-MM-DD
ids	string	Não	Lista de identificadores das atividades não relacionadas a visitas, separados por vírgulas
user_id	integer	Não	Identificador do usuário no Proxima CRM. Retorna atividades não relacionadas a visitas para um usuário específico

Resposta bem-sucedida

200 OK

Formato csv: a resposta é retornada como texto CSV.

Content-Type

text/plain

Exemplo de resposta

action_id,action_name,action_datefrom,action_datetill,action_tasktype,action_user_id,action_state
1001,Internal Meeting,2025-08-04T10:00:00Z,2025-08-04T11:00:00Z,Meeting,12,Completed

Campo	Descrição
action_id	Identificador da tarefa na base Proxima CRM
action_name	Nome ou título da tarefa
action_datefrom	Data e hora de início planejado da tarefa (UTC). Formato: YYYY-MM-DD HH:MM:SS
action_datetill	Data e hora de término planejado da tarefa (UTC). Formato: YYYY-MM-DD HH:MM:SS
action_tasktype	Tipo de tarefa (por exemplo, Reunião, Treinamento, Trabalho administrativo)
action_user_id	Identificador do usuário responsável pela tarefa no Proxima CRM
action_state	Status da tarefa (por exemplo, Planejada, Concluída, Cancelada)

Resposta de erro

40x/50x

{
  "message": "string"
}

Código	Descrição
400	Requisição inválida (por exemplo, parâmetros obrigatórios ausentes)
401	Não autorizado (token inválido ou ausente)
500	Erro interno do servidor

Pesquisa