api_get_users – Proxima Research Brazil

Obtém a lista de todos os usuários do sistema Proxima CRM. Opcionalmente, a lista pode ser filtrada por identificadores específicos de usuários.

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_users",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
function	string	Sim	Nome do método chamado — "api_get_users"
format	string	Sim	Formato da resposta — csv
arguments	object	Não	Argumentos opcionais específicos do método
ids	string	Não	Lista de IDs de usuários separados por vírgula. Se não informado, retorna todos os usuários

Resposta bem-sucedida

200 OK

Dependendo do formato especificado (csv), o sistema retorna a lista de usuários como texto simples.

Content-type

text/plain

Exemplo de resposta

name,manager,country,region,direction,position,active,user_id,workstartdate,workenddate,role
Ivan Petrov,A. Sidorov,Ukraine,Kyiv,RX,Medical Rep,0,12,2022-05-01,2025-05-01,ROLE_USER

Descrição dos campos

Campo	Descrição
name	Nome completo do usuário
manager	Supervisor direto
country	País onde o usuário trabalha
region	Regiões de atuação
direction	Linha ou direção do produto
position	Cargo do usuário
Active	Status de atividade: 0 = ativo, 1 = inativo
user_id	ID interno do usuário no Proxima CRM
workstartdate	Data de início do trabalho
workenddate	Data de término do trabalho
role	Função do sistema (por exemplo, ROLE_USER, ROLE_ADMIN)

Resposta de erro

40x/50x

{
  "message": "string"
}

Código	Descrição
400-499	Erro do cliente
500-599	Erro do servidor

Pesquisa