Document sharing

List the recipients of a share

Who a sent share reached and what they did: delivery status, when they first and last opened their area, how many of their documents they downloaded and when. Filter downloaded: false for the ones still to chase.

Examples

  • Who has not downloaded yet? GET /api/v1/rest/condivisione/recipients?shareId=11111111-2222-4333-8444-555555555555&downloaded=false
get/api/v1/rest/condivisione/recipients

Request

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

Query parameters

shareIdstring uuid

One share’s recipients; omit for every share that went out.

querystring

Free text over name, address, title.

status'pending' | 'queued' | 'sent' | 'failed' | 'skipped' | 'cancelled'
openedboolean

true: only who opened their area; false: who never did.

downloadedboolean

true: only who downloaded something; false: who downloaded nothing.

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.