---
title: "Listar columnas de Report"
method: GET
path: "/reports/{entity}/columns"
tags: ["Reports"]
---

# Listar columnas de Report

`GET /reports/{entity}/columns`

## Request

- Base URL: `https://api.trytoku.com`
- URL: `https://api.trytoku.com/reports/{entity}/columns`
- Auth: API key in header `x-api-key`

Devuelve las columnas que trae el reporte de la entidad indicada.

Cada elemento entrega `field`, el nombre interno de la columna, y `label`, su nombre traducido al idioma del país de la organización. Se usa para saber qué columnas se pueden excluir con `exclude` al generar el reporte, sin tener que generarlo primero.

La lista incluye las claves de metadata que la organización tenga configuradas en Customers, Subscriptions e Invoices, por lo que puede variar entre organizaciones.

## Path parameters

- `entity` 'bank_account_verification' | 'billing' | 'campaign' | 'card_verification' | 'customer' | 'customer_portal_event' | 'interaction_event' | 'invoice' | 'message' | 'payment' | 'payment_v2' | 'payment_intent' | 'payment_method' | 'payout' | 'payout_v2' | 'subscription' | 'ticket' | 'payment_method_inscription_intent' | 'pac_inscription_intent' | 'payout_additional' | 'campaign_customer' | 'campaign_invoice' | 'transfer_cl_activation' | 'electronic_signature_document' | 'chargeback' | 'chargeback_v2' | 'temporary_collection_file' | 'recipient_verification' | 'conversations_ai_agent' | 'forum_notification' | 'payout_disbursement' | 'beneficiary_account' | 'payout_batch' | 'reconciliation', required: Conjunto de datos que se exporta. Cada valor apunta a un reporte distinto, con sus propias columnas y hojas, así que es lo que determina la forma del archivo resultante. Es un catálogo que crece al publicar reportes nuevos, y no todos los valores están disponibles para toda organización: algunos dependen de sus permisos y otros exigen parámetros adicionales. Los valores terminados en `_v2` no son otro formato del mismo reporte, sino una versión que lee un modelo de datos más nuevo, con columnas y hojas distintas.

## Response `200`

Successful Response

- object[]

## Other responses

- `401`: Faltan las credenciales o son inválidas.
- `403`: No tienes acceso a este recurso.
- `404`: La entidad indicada no tiene reporte disponible.
- `422`: El cuerpo de la petición no pasó la validación.
- `429`: Se superó el límite de peticiones permitidas.

## Changes

- **2026-11-03** `a6ef070075b1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/trytoku/apis/toku-api/changes/reports/:entity/columns/get.md)

---

[API](https://skmtc.dev/trytoku/apis/toku-api.md) - [All operations](https://skmtc.dev/trytoku/apis/toku-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trytoku/apis/toku-api/revisions/a6ef070075b1?raw)
