---
title: "Read a module’s settings"
method: GET
path: "/api/v1/rest/module-settings"
tags: ["Platform"]
---

# Read a module’s 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

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`

## 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'

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)