API Reference / Ricerca globale

Ricerca globale

Un solo endpoint che cerca in tutti i moduli, base e custom, e restituisce i risultati raggruppati per modulo. Rispetta permessi e scope: ogni utente trova solo ciò che può vedere.

GET /api/search bearer richiesto

Cerca il termine q nei campi principali di ogni modulo su cui l'utente ha il permesso di lettura, applicando lo scope (own/team/all) direttamente nelle query. Fino a 5 risultati per modulo.

Parametri query

Parametro	Tipo		Descrizione
q	string	richiesto	Il termine da cercare (max 255 caratteri). Con meno di 2 caratteri la risposta è vuota (`groups: []`), senza errore.

Richiesta

curl "https://crm.tuodominio.it/api/search?q=rossi" \
  -H "Authorization: Bearer <accessToken>"

const res = await fetch("https://crm.tuodominio.it/api/search?q=rossi", {
  headers: { Authorization: `Bearer ${accessToken}` },
});
const { data } = await res.json();

Risposta · 200

json

{
  "success": true,
  "data": {
    "q": "rossi",
    "groups": [{
      "module": "contacts",
      "label": "Contatti",
      "icon": "person",
      "items": [{
        "id": "957",
        "title": "Mario Rossi",
        "subtitle": "mario.rossi@cliente.it",
        "url": "/modules/contacts/957"
      }]
    }]
  }
}

01Cosa cerca e cosa no

Moduli base: i campi principali di ogni modulo (nomi, email, oggetto…).
Moduli custom: inclusi automaticamente, sui loro campi.
Permessi: un modulo su cui non hai il permesso di lettura non compare proprio nei gruppi; dentro un modulo, lo scope filtra i record come nelle liste.
La corrispondenza è per sottostringa, case-insensitive. Per ricerche strutturate (operatori, più condizioni) usa i filtri avanzati delle liste.

← PrecedenteConnessioni Successiva →Report