Consultar cliente

Retorna o cadastro completo de um usuário, com os grupos e os campos de perfil.

Use esta operação quando você já tem o id do usuário e quer o cadastro inteiro: documento, nome da empresa (PJ), idioma, preferências de contato, status, grupos e campos de perfil. Para achar o id a partir de um e-mail ou documento, use Listar clientes com search, email ou cnpj.

O que a consulta não traz: endereços (veja Endereços), pedidos (Pedidos e carrinho) e crédito (Crédito e pagamento). A senha e o hash nunca saem pela API.

GET/api/v1.0/users/{id}Admin

Consultar um usuário

Autenticação como em Listar clientes. Também responde em /api/users/{id} (id decimal).

Parâmetros de caminho

idstringobrigatório

Id do usuário (UUID; na rota /api/users/{id}, o id decimal).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f"

Resposta

200Usuário encontrado

json

{
  "user_id": "3dc023ca-3746-4b6e-8afd-686a4a9af99f",
  "profile_id": "3dc023ca-3746-4b6e-8afd-686a4a9af99f",
  "email": "contato@paodoce.example.com",
  "firstname": "Padaria Pão Doce Ltda",
  "lastname": "",
  "user_type": "C",
  "status": "A",
  "password": "",
  "phone": "+551133334444",
  "fax": "",
  "url": "",
  "company": "",
  "company_id": 0,
  "usergroup_ids": "f4652f1d-fa2c-4ac8-9cc8-bba8c308f19b",
  "usergroups": [
    { "usergroup_id": "f4652f1d-fa2c-4ac8-9cc8-bba8c308f19b", "usergroup": "Atacado", "status": "A" }
  ],
  "fields": [
    { "field_id": "1bf6d0a9-56a9-495d-a51a-160c39bcd2f9", "field_name": "company_name", "value": "Padaria Pão Doce Ltda" },
    { "field_id": "19d6bcb8-9d1f-4750-aa10-1e2feba51366", "field_name": "responsible_name", "value": "João Pereira" }
  ],
  "lang_code": "pt-BR",
  "timestamp": 1791752151,
  "tax_exempt": "N",
  "birthday": "",
  "registration_date": "2026-10-11 20:55:51",
  "last_login": 0,
  "CNPJ": "11222333000181"
}

Campos da resposta

usergroup_idsstring

Ids dos grupos com vínculo ativo (A), separados por vírgula. Vazio se não há nenhum.

usergroupsarray

Todos os vínculos do usuário, com usergroup_id, usergroup (nome) e status do vínculo (A, P, F, D; veja Grupos de usuários).

fieldsarray

Valores dos campos de perfil: field_id, field_name e value. Inclui os campos nativos (email, first_name, last_name, phone, cpf) e os que a loja criou. Veja Campos de perfil.

companystring

Só para usuário V: nome do seller. Vazio nos demais.

company_idstring

Só para usuário V: id do seller (UUID). Nos demais, 0.

urlstring

Para usuário V, o site do seller quando existe; nos demais, vazio.

Os demais campos são os de Listar clientes (user_id, email, firstname, lastname, user_type, status, phone, lang_code, timestamp, registration_date, last_login, CNPJ, e os fixos password, fax, tax_exempt, birthday).

Erros

Status	Quando	Corpo
401	Sem credenciais, chave inválida ou token expirado	`{"message":"Invalid credentials","status":401}`
403	Não é administrador	`{"message":"Forbidden: admin scope required","status":403}`
404	Usuário não existe ou foi excluído	`{"message":"User not found","status":404}`
500	Id que não é UUID	`{"message":"query user abc: pq: invalid input syntax for type uuid: \"abc\" (22P02)","status":500}`

Veja também