Elenca persone (anagrafica soggetti)
domustudio_list_personeList people from a Domustudio archive, optionally filtered by condominio, tags, or search query, to retrieve condòmini contacts and per-building counts in markdown or JSON.
Instructions
Elenca le persone dell'anagrafica Domustudio, opzionalmente ristrette a un condominio.
L'API non espone un identificatore per le persone: il record non contiene alcun id, quindi non esiste una lettura per id e non c'è modo di indirizzare una persona singola. Per trovare qualcuno si filtra questo elenco (search_query, oppure condominio_id più una lettura dei risultati).
Args:
archivio (string, opzionale): archivio da interrogare
condominio_id (number, opzionale): restringe a un condominio (parametro CondGendID). Ottenerlo da domustudio_list_condomini
filtro_subentri (1|2|3|4|5): 1 tutti, 2 attivi, 3 ex, 4 contabilità, 5 destinatari comunicazioni. Default 2
esercizio_id (number, opzionale): parametro EsercizioID
tags_id (number[], opzionale): parametro TagsID
search_query (string, opzionale): passato all'API come SearchQuery; la semantica è decisa dall'API, non documentata nello spec
order_by (string, opzionale): passato all'API come OrderBy, semantica non documentata
pagina (number): pagina 1-based, default 1
dimensione_pagina (number): elementi per pagina, default 50
tutte_le_pagine (boolean): se true scorre le pagine fino a 50, default false
response_format ('markdown' | 'json'): default 'markdown'
Restituisce (json): { "archivio": string, "conteggio": number, // elementi in questa risposta "pagina": number, // prima pagina letta "dimensione_pagina": number, "pagine_lette": number, "ha_altre_pagine": boolean, // euristica: l'API non restituisce un totale, quindi è vero quando l'ultima pagina era piena "prossima_pagina": number, // presente solo se ha_altre_pagine "troncato_al_limite_pagine": boolean, "elementi": [ { "descr": string, "codFisc": string, "piva": string, "indirizzo": string, "cap": string, "citta": string, "prov": string, "email": string[], "pec": string[], "tel1": string, "note": string, "preferenzaPagamentoRate": { "codice": number, "etichetta": string }, ... } ] } I campi enumerativi sono restituiti come { codice, etichetta }. Il formato markdown mostra denominazione, codice fiscale, indirizzo, recapiti; json riporta il record completo.
Usare quando: servono i condòmini di uno stabile, i recapiti di un soggetto, o un conteggio per condominio. Non usare per: i fornitori, che stanno in un'anagrafica separata (domustudio_list_fornitori).
L'API Domustudio è di sola lettura: espone solo tre endpoint GET. Domustudio resta il sistema di registrazione — ogni correzione va fatta da un operatore dentro il gestionale.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pagina | No | Numero di pagina, 1-based (parametro PageNumber dell'API). | |
| tags_id | No | Id dei tag (TagsID). | |
| archivio | No | Nome dell'archivio Domustudio da interrogare. Opzionale se ne è configurato uno solo; usare domustudio_list_archivi per l'elenco. | |
| order_by | No | Ordinamento, inoltrato all'API come OrderBy. | |
| esercizio_id | No | Id dell'esercizio (EsercizioID). | |
| search_query | No | Ricerca libera, inoltrata all'API come SearchQuery. | |
| condominio_id | No | Id del condominio (CondGendID). Omesso, l'API restituisce le persone di tutto l'archivio. | |
| filtro_subentri | No | 1 tutti, 2 attivi, 3 ex, 4 contabilità, 5 destinatari comunicazioni | |
| response_format | No | 'markdown' per una sintesi leggibile dei campi principali, 'json' per il record completo. | markdown |
| tutte_le_pagine | No | Se true, scorre le pagine successive fino a esaurimento o fino a 50 pagine (il campo troncato_al_limite_pagine segnala il taglio). | |
| dimensione_pagina | No | Elementi per pagina (parametro PageSize dell'API). Massimo 100. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pagina | Yes | ||
| archivio | Yes | ||
| elementi | Yes | ||
| conteggio | Yes | ||
| pagine_lette | Yes | ||
| ha_altre_pagine | Yes | ||
| prossima_pagina | No | ||
| dimensione_pagina | Yes | ||
| troncato_al_limite_pagine | Yes |