Usuários · miCore

O que é

Usuários expõe a equipe do tenant pela API. É um recurso de apoio: serve para descobrir quem são as pessoas e os ids delas, que outros recursos usam.

Na prática: você lista os usuários e usa o id de cada um ao atribuir responsáveis a tarefas ou ao definir o vendedor de um cliente.

O que dá para fazer hoje

Listar os usuários da equipe, com filtros e busca.
Consultar um usuário pelo id.

Importante

Só leitura: a API não cria nem edita usuários.
Senha e tokens nunca são expostos.
Exige o escopo users:read e a permissão de ver usuários.

Disponibilidade na API

Endpoints de Usuários

Consulte os usuários disponíveis no tenant e seus dados de identificação. Os exemplos abaixo são gerados pelo contrato OpenAPI oficial.

GET /api/v1/users

Lista usuários da equipe

Exige o escopo `users:read`. Use para descobrir os ids usados ao atribuir responsáveis ou definir o vendedor de um cliente.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`status`query	boolean	Não	Ativo (true) ou inativo (false).
`seller`query	boolean	Não	Apenas vendedores.
`search`query	string	Não	Busca por nome ou e-mail.
`per_page`query	integer	Não	—

Exemplo de requisição

cURL

curl "$MICORE_BASE_URL/users" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200

{
    "data": [
        {
            "id": 7,
            "name": "Ana Souza",
            "email": "ana@empresa.com",
            "status": true,
            "seller": true,
            "role": {
                "id": 3,
                "name": "Vendedor"
            },
            "created_at": "2026-10-17T09:00:00-03:00",
            "updated_at": "2026-10-17T09:00:00-03:00"
        }
    ],
    "links": [],
    "meta": []
}

Respostas possíveis

200 Página de usuários401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente422 Dados inválidos429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant

GET /api/v1/users/{user}

Exibe um usuário

Exige o escopo `users:read`.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`user`path	integer	Sim	—

Exemplo de requisição

cURL

curl "$MICORE_BASE_URL/users/{user}" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200

{
    "data": {
        "id": 7,
        "name": "Ana Souza",
        "email": "ana@empresa.com",
        "status": true,
        "seller": true,
        "role": {
            "id": 3,
            "name": "Vendedor"
        },
        "created_at": "2026-10-17T09:00:00-03:00",
        "updated_at": "2026-10-17T09:00:00-03:00"
    }
}

Respostas possíveis

200 Usuário encontrado401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado429 Cota por minuto da credencial excedida503 O domínio não pôde ser associado com segurança a um tenant