Platform

Read a module’s settings

Read-only business configuration for the modules this organisation has enabled: retention and upload limits, the CRM’s lead inbox and lost-reason rule, mail sync and undo-send windows, signature expiry, expense policy. It returns ONLY the fields on the tool allow-list — the ceilings and kill switches that govern integrations and agents are withheld in full, and no credential of any kind is ever in this answer. withheld counts the fields this answer is not showing, so an empty object is never «unconfigured». Nothing here writes: to change a setting, ask a person to open Impostazioni.

Examples

  • Il lead inbox del CRM è attivo? GET /api/v1/rest/module-settings?module=crm
  • How long do we keep documents by default? GET /api/v1/rest/module-settings?module=documents
  • How is this organisation configured? GET /api/v1/rest/module-settings
get/api/v1/rest/module-settings

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/module-settings
  • Auth: HTTP bearer

Query parameters

module'core' | 'documents' | 'conservazione' | 'anagrafiche' | 'tabelle' | 'email' | 'whatsapp' | 'protocolli' | 'workflow' | 'attivita' | 'checklist' | 'calendario' | 'crm' | 'spese' | 'timbratura' | 'firme' | 'raccolta' | 'condivisione' | 'integrazioni' | 'agenti' | 'bi' | 'ordini' | 'notifiche'

One module’s settings, e.g. crm. Omit for every module this organisation has enabled.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.