---
title: "Link to a Custodo page"
method: GET
path: "/api/v1/rest/views/link"
tags: ["Platform"]
---

# Link to a Custodo page

`GET /api/v1/rest/views/link`

## Request

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

Build the web address of a Custodo page with filters, search, sort and grouping applied, on one of its tabs, or opening one record — for the person to click. It reads and changes nothing: the page shows only what the person may see. Use it to hand over the result of a search as a view («open these invoices in Custodo») rather than a long list. query keys: q (free text over content — for a named field use filter instead), filter (field:op:value joined by ~; text ops contains, eq, startsWith, endsWith; number/date eq, gt, gte, lt, lte, between with values joined by |), sort (field:asc|desc joined by ~), group (one field key), and the page params type, status, direction, from, to, scope, assignee, role, kind, category, date, view. Archivio fields: title, filename, typeName, createdAt, size, and metadata as meta.text.KEY / meta.number.KEY / meta.date.KEY (read the class schema from documents_list_types for real KEYs); type is a class id. Tabs (page): spese: note; raccolta: richieste, pianificazioni, non-abbinate; condivisione: destinatari, download, automatici; conservazione: versamenti, catena, esibizioni, scarti; calendario: scadenze; crm: lead, attivita; firme: da-firmare, firmate-da-me; workflow: flows; integrazioni: client, webhook, chiamate, strumenti. record opens one record by its id. Never invent ids or field keys.

**Examples**

- Dammi il link alle fatture di Bianchi raggruppate per anno
  `GET /api/v1/rest/views/link?module=documents&title=Fatture+di+Bianchi+per+anno&query=%7B%22filter%22%3A%22meta.text.controparte%3Acontains%3ABianchi%22%2C%22group%22%3A%22meta%3Aanno%22%7D`
- Link to the expense reports waiting for approval
  `GET /api/v1/rest/views/link?module=spese&title=Note+spese&page=note&query=%7B%22status%22%3A%22submitted%22%7D`

## Query parameters

- `module` 'core' | 'documents' | 'anagrafiche' | 'tabelle' | 'email' | 'whatsapp' | 'workflow' | 'attivita' | 'calendario' | 'checklist' | 'crm' | 'firme' | 'raccolta' | 'condivisione' | 'bi' | 'spese' | 'conservazione' | 'integrazioni' | 'agenti', required
- `title` string, required
- `page` string
- `record` string, uuid

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, 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)