Document sharing

List shares

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/shares?status=sent
  • How is the share about the balance sheet going? GET /api/v1/rest/condivisione/shares?query=bilancio
get/api/v1/rest/condivisione/shares

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/condivisione/shares
  • Auth: HTTP bearer

Query parameters

status'draft' | 'scheduled' | 'sending' | 'sent' | 'failed' | 'cancelled' | 'withdrawn'

Omit for every share.

querystring

Free text over the title and subject.

limitinteger

Rows to return, 1–100. Default 20.

cursorstring

Opaque cursor from a previous call’s nextCursor, to continue.

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.