List shares (module status)
Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.
The shares of «Condivisione documentale» (called «Circolari», and its tools circolari_*, until 2026-09-30): mass mailings whose archive documents wait behind a personal link per recipient. Each row has its status (draft, scheduled, sending, sent, failed, cancelled, withdrawn) and the counts — recipients, sent, failed, skipped, how many opened their area and how many downloaded. cursor is a page number.
Examples
- Which shares went out? GET /api/v1/rest/condivisione/status?status=sent
- How is the share about the balance sheet going? GET /api/v1/rest/condivisione/status?query=bilancio
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/condivisione/status
- Auth: HTTP bearer
Query parameters
Omit for every share.
Free text over the title and subject.
Rows to return, 1–100. Default 20.
Opaque cursor from a previous call’s nextCursor, to continue.
Headers
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.
Changes
No recorded changes to this operation across all 1 revision of this API.