Document sharing

Read one share (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.

One share whole: its message, its audience rule (roles, picked anagrafiche, typed addresses), its documents (common ones, and whether each recipient also gets the documents of their anagrafica), its access rule (password mode, link term) and the counts. For the recipients one by one, call condivisione_list_recipients.

Examples

  • Show me that share GET /api/v1/rest/condivisione/shares/11111111-2222-4333-8444-555555555555/status
get/api/v1/rest/condivisione/shares/{id}/status

Request

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

Path parameters

idstring uuid required

The share’s id.

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.