Document collection

List document collections

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/collections?status=active
  • How is the DURC collection going? GET /api/v1/rest/raccolta/collections?query=DURC
get/api/v1/rest/raccolta/collections

Request

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

Query parameters

status'draft' | 'active' | 'closed'

Omit for every raccolta.

querystring

Free text over the name.

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.