---
title: "Export to Excel"
method: GET
path: "/api/v1/rest/crm/export"
tags: ["CRM"]
---

# Export to Excel

`GET /api/v1/rest/crm/export`

## Request

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

Builds the workbook the CRM’s «Esporta» button produces — deals and activities on two tabs, each deal with its customer’s name — and hands it back base64-encoded rather than as rows. Call it ONLY when the user asked for the FILE: to answer a question about the data use crm_list_deals or crm_list_activities, which cost a fraction of the context. Refused above 2000 rows, because a file that looks complete and is not is the worst possible answer — narrow the filters and retry. Every call is recorded in the activity log.

**Examples**

- Send me the pipeline as a spreadsheet
  `GET /api/v1/rest/crm/export?entities=deals`
- Export the open pipeline for Laura
  `GET /api/v1/rest/crm/export?entities=deals&status=open&owner_user_id=55555555-6666-4777-8888-999999999999`

## Query parameters

- `entities` string[]
- `query` string
- `status` 'open' | 'won' | 'lost'
- `pipeline_id` string, uuid
- `stage_id` string, uuid
- `owner_user_id` string, uuid
- `party_id` 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)