Come ottenere i layout in Zoho

Recuperare i layout in Zoho CRM è semplice una volta che sai quali endpoint API chiamare — puoi ottenere tutti i layout per un modulo o approfondire un singolo layout tramite il suo ID.

Perché è importante

I layout in Zoho CRM controllano quali campi, sezioni e regole vengono presentati agli utenti quando creano o modificano record in un determinato modulo. Se stai costruendo un'integrazione, automatizzando l'inserimento dati o verificando la configurazione del tuo CRM, dovrai recuperare programmaticamente le definizioni dei layout per comprendere la struttura di ciascun modulo. Conoscere gli endpoint corretti consente di risparmiare molto tempo di tentativi ed errori.

> Nota: Beam Help è un servizio di supporto esperto indipendente per Zoho — non siamo il supporto ufficiale Zoho.

---

Passo dopo passo

Passo 1. Per recuperare tutti i layout di un modulo specifico, invia una richiesta GET all'endpoint /settings/layouts, passando il nome del modulo come parametro di query module. Ad esempio, per ottenere i layout del modulo Leads dovresti chiamare GET /settings/layouts?module=Leads. ^[4]

Passo 2. Il metodo sottostante accetta un singolo argomento stringa che rappresenta il nome del modulo (m), e l'API di Zoho CRM restituisce l'elenco completo dei layout configurati per quel modulo. ^[4]

# Example usage
layouts = get_layouts(m="Leads")

Passo 3. Se conosci già il layout specifico di cui hai bisogno, utilizza invece l'endpoint per il singolo layout: GET /settings/layouts/{lid}, dove {lid} è l'ID del layout. Devi comunque passare il nome del modulo come parametro di query insieme all'ID del layout. ^[5]

Passo 4. La firma del metodo per recuperare un singolo layout accetta due argomenti — il nome del modulo (m) e l'ID del layout (lid). ^[5]

# Example usage
layout = get_layout(m="Leads", lid="4567890123456789")

Passo 5. Una volta ottenuto l'ID del layout, puoi scendere di un livello e recuperare i campi appartenenti a quel layout. Usa GET /api/v1/layouts/{layoutId}/fields, passando il layoutId come parametro di percorso. Un parametro di paginazione opzionale (p) può essere fornito come dizionario se l'elenco dei campi è lungo. ^[7]

# Example usage
fields = get_layout_fields(layoutId="4567890123456789", p={"page": 1})

Passo 6. Usa la risposta sui campi per capire esattamente quali campi sono presenti in un layout, il loro ordine e qualsiasi metadato associato — questo è particolarmente utile quando si mappano i dati CRM verso un sistema esterno o si verifica che i campi obbligatori esistano prima di inviare i record. ^[7]

---

Errori comuni

• Maiuscole/minuscole errate nel nome del modulo. I nomi dei moduli nell'API di Zoho CRM sono sensibili alle maiuscole in molti contesti (ad es., Leads e non leads). Usa sempre il nome API così come appare nelle impostazioni del tuo CRM, non l'etichetta visualizzata.
• ID layout mancante. L'endpoint per il singolo layout (/settings/layouts/{lid}) richiede un ID layout valido. Se salti i Passi 1–2 e cerchi di indovinare un ID, la richiesta fallirà. Recupera sempre prima l'elenco completo per ottenere ID validi. ^[4][5]
• Confusione tra layout CRM e layout Desk. Gli endpoint /settings/layouts descritti qui sono specifici di Zoho CRM. Zoho Desk utilizza una struttura di percorso diversa (/api/v1/layouts/{layoutId}/fields) per il recupero dei campi dei propri layout. Assicurati di puntare all'URL base del prodotto corretto. ^[4][7]

---

Cosa verificare

• Conferma il nome del modulo come nome API (non il nome visualizzato) facendo riferimento alle impostazioni dei moduli del tuo CRM prima di effettuare la chiamata. ^[4]
• Verifica l'ID del layout restituito nella risposta di tutti i layout corrisponda al layout che intendi esaminare prima di chiamare gli endpoint del singolo layout o dei campi. ^[5]
• Controlla la paginazione sull'endpoint dei campi se il tuo layout contiene molti campi — usa il parametro opzionale p per scorrere i risultati e assicurarti che nessun campo venga omesso. ^[7]