Document collection

List the recipients of a collection (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 per-recipient requests: who was asked, whether the request went out, how many reminders they have had, whether they answered and which of the requested documents are still missing. Filter by collection, status, overdue or exhausted (every reminder spent and still no answer — the ones to phone).

Examples

  • Who has not sent the visura yet? GET /api/v1/rest/raccolta/requests/status?status=sent
  • Who should I phone? GET /api/v1/rest/raccolta/requests/status?exhausted=true
get/api/v1/rest/raccolta/requests/status

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/raccolta/requests/status
  • Auth: HTTP bearer

Query parameters

collection_idstring uuid
status'pending' | 'sent' | 'received' | 'cancelled'
overdueboolean

Only requests sent and still unanswered past the due date.

exhaustedboolean

Only requests that had every reminder.

querystring

Name, address or request code.

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 answer, as described here. Its objects may carry fields this description does not name yet: read the ones you need and ignore the rest.

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.