---
title: "List document collections"
method: GET
path: "/api/v1/rest/raccolta/collections"
tags: ["Document collection"]
---

# List document collections

`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

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`

## Query parameters

- `status` 'draft' | 'active' | 'closed'
- `query` string
- `limit` integer
- `cursor` string

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

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.

- object
  - `ok` true, required
  - `data` RaccoltaListCollectionsResult, required
    - `collections` object[], required
      - `id` string, required
      - `name` string, required
      - `status` 'draft' | 'active' | 'closed', required
      - `channel` 'email' | 'whatsapp', required
      - `mailbox` string, nullable, required
      - `document_types` string[], required
      - `due_on` string, nullable, required
      - `counts` object, required
        - `total` number, required
        - `pending` number, required
        - `sent` number, required
        - `received` number, required
        - `cancelled` number, required
        - `overdue` number, required
        - `itemsTotal` number, required
        - `itemsReceived` number, required
    - `next_cursor` string, nullable, required: Pass it back as `cursor` for the next page; null on the last one.
    - `total` number, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)