API · search

Operações de search do contrato OpenAPI que aceitam uma chave de API.

Atualizado:

Búsqueda global agrupada por tipo (solo sesión de panel)

Busca q en clientes (nombre, teléfono, email), conversaciones (cliente o último mensaje), tareas (cliente, servicio o código: el prefijo hexadecimal del id, con o sin #) y recursos y servicios (nombre). Devuelve un grupo por tipo con tope limit (por defecto 5, máximo 10); un término de menos de 2 caracteres (3 para el repartidor) devuelve todos los grupos vacíos. Sin dinero en ningún tipo. Respeta la visibilidad de cada pantalla: clientes, recursos y servicios solo para owner/manager (el viewer y el repartidor no tienen esas pantallas: sus grupos vienen vacíos); conversaciones para owner, manager, viewer y repartidor; tareas para todos. El repartidor (staff) solo ve las conversaciones de sus clientes (contacto enmascarado) y las tareas asignadas a sus recursos, con el mismo rate limit de 30 búsquedas/min que la búsqueda de clientes del repartidor (429 customer_search_rate_limited). Cada tipo corre con un statement_timeout corto; si alguno se pasa del tiempo se omite y partial es true. Solo cookie de sesión: no tiene scope de API key (un bearer recibe 403). El término es PII: no se loguea ni se audita crudo. Índices pg_trgm (migración f7a0b1c2d3e4).

  • Autenticação: Chave de API ou sessão do painel
  • Escopos: Nenhum

Parâmetros

NomeEmObrigatórioTipoDescrição
qquerySimstringNombre
limitqueryNãointeger default 5Tope por tipo

Respostas

StatusDescrição
200OK (SearchResults)
401Error (RFC 9457) (Problem)
403Error (RFC 9457) (Problem)
422Error (RFC 9457) (Problem)
429Error (RFC 9457) (Problem)
defaultError (RFC 9457) (Problem)