---
title: "List the recipients of a collection"
method: GET
path: "/api/v1/rest/raccolta/requests"
tags: ["Document collection"]
---

# List the recipients of a collection

`GET /api/v1/rest/raccolta/requests`

## Request

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

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=sent`
- Who should I phone?
  `GET /api/v1/rest/raccolta/requests?exhausted=true`

## Query parameters

- `collection_id` string, uuid
- `status` 'pending' | 'sent' | 'received' | 'cancelled'
- `overdue` boolean
- `exhausted` boolean
- `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` RaccoltaListRequestsResult, required
    - `requests` object[], required
      - `id` string, required
      - `collection` string, required
      - `recipient` string, required
      - `email` string, nullable, required
      - `whatsapp` string, nullable, required
      - `channel` 'email' | 'whatsapp', required
      - `code` string, required
      - `status` 'pending' | 'sent' | 'received' | 'cancelled', required
      - `sent_at` string, nullable, required
      - `reminders` number, required
      - `exhausted` boolean, required: Every reminder spent and still no answer.
      - `overdue` boolean, required
      - `received` string, required: Documents received of those asked for, e.g. `1/3`.
    - `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)