Pular para o conteúdo principal

Pesquisa

api_get_users_json

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_json",
  "format": "json",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Campo Tipo Obrigatório Descrição
function string Sim Nome do método API — "api_get_users_json".
format string Sim Formato de resposta — JSON.
arguments object Sim Bloco de parâmetros.
ids string Não Lista de IDs separados por vírgula. Se não informado, retorna todos os usuários.

Resposta bem-sucedida

200 OK

Formato JSON

Exemplo de resposta
[
    {
        "name": "Ivan Petrov",
        "role": "ROLE_USER_RM",
        "region": [
            "Kyiv"
        ],
        "country": "Ukraine",
        "manager": "A. Sidorov",
        "user_id": 7,
        "position": "MR",
        "direction": [
            "Rx"
        ],
        "workenddate": "2025-02-08",
        "workstartdate": "2025-02-08",
        "active": 0
    }
]
Campo Descrição
name Nome completo
manager Gestor imediato
country País de trabalho
region Regiões de atuação
direction Linha/direção de produto
position Cargo
user_id ID interno do usuário
workstartdate Data de início
workenddate Data de término
role Função/role do sistema

Ошибочный ответ

40x/50x

{
  "message": "string"
}
Código Descrição
400-499 Erro do cliente
500-599 Erro do servidor