Document collection

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

One raccolta with its requested document types, its mailbox, its template, its reminder cadence and the counts. For the recipients, call raccolta_list_requests with its id.

Examples

  • Show me that collection GET /api/v1/rest/raccolta/collections/11111111-2222-4333-8444-555555555555/status
get/api/v1/rest/raccolta/collections/{id}/status

Request

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

Path parameters

idstring uuid required

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.