List document collections (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 raccolte: campaigns asking a set of customers for a document by email. Each row carries the counts — how many were asked, how many answered, how many are still missing and how many are past the due date. cursor is a page number.
Examples
- Which collections are still open? GET /api/v1/rest/raccolta/status?status=active
- How is the DURC collection going? GET /api/v1/rest/raccolta/status?query=DURC
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/raccolta/status
- Auth: HTTP bearer
Query parameters
Omit for every raccolta.
Free text over the name.
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 answer, as described here. Its objects may carry fields this description does not name yet: read the ones you need and ignore the rest.
Changes
No recorded changes to this operation across all 1 revision of this API.