> ## Documentation Index
> Fetch the complete documentation index at: https://firespark.cloud/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtener canal

> Lee una definición de canal de venta por id externo.

Devuelve un canal para el comercio autenticado. Usa este endpoint cuando ya conoces el `id` externo y necesitas el nombre, tipo, estado y configuración CMS actuales sin listar todos los canales.

> [!NOTE]
>
> Requiere un access token con el scope `channels:read`. Consulta
> [Token](https://firespark.cloud/docs/es/integrations-api/oauth/token/post.md) para obtener un token.

## Solicitud

Reemplaza `{id}` con el identificador externo del canal.

```bash theme={null}
curl "https://firespark.cloud/api/integrations/v1/channels/app" \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

## Respuesta

La respuesta envuelve un objeto de canal en `data`.

```json Success theme={null}
{
  "data": {
    "id": "app",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Mobile app",
    "type": "APP",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "App landing page",
      "entity": "CHANNELS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "hero_title",
          "type": "TEXT",
          "label": { "en_us": "Hero title" },
          "required": true,
          "value": "Order from our app"
        }
      ]
    }
  }
}
```

## Parámetros de ruta

| Parámetro | Tipo | Descripción |
| - | - | - |
| `id` | string | Identificador externo del canal. Solo caracteres alfanuméricos, `_` y `-`. 1–64 caracteres. Único por comercio. |

## Objeto channel

| Campo | Tipo | Descripción |
| - | - | - |
| `id` | string | Identificador externo del canal. Coincide con el parámetro de ruta. |
| `uid` | string (UUID) | Identificador interno de Fire spark. |
| `merchant_id` | string (UUID) | Comercio al que pertenece el canal. |
| `name` | string | Nombre visible. 1–100 caracteres. |
| `type` | string | Superficie del canal. Uno de `APP`, `WEB`, `KIOSK`, `POS`, `CALL_CENTER` o `AGGREGATOR`. Se define al crear; no cambia. |
| `status` | string | `ACTIVE` o `INACTIVE`. |
| `cms_template_id` | string (UUID) | Plantilla CMS vinculada a este canal. `null` si no hay plantilla asignada. |
| `cms` | object | Solo lectura. `null` cuando `cms_template_id` es `null`. Si existe, la plantilla CMS resuelta para este canal. |

> [accordion] cms
>
> Presente solo cuando `cms_template_id` no es `null`. Contiene la plantilla CMS resuelta asignada al canal.
>
> | Campo | Requerido | Tipo | Descripción |
> | - | - | - | - |
> | `id` | Sí | string (UUID) | Identificador de la plantilla. Coincide con `cms_template_id`. |
> | `name` | Sí | string | Nombre de la plantilla. 1–100 caracteres. |
> | `entity` | Sí | string | Siempre `CHANNELS` en respuestas de canal. |
> | `status` | Sí | string | `ACTIVE` o `INACTIVE`. |
> | `fields` | Sí | array | Campos de la plantilla con sus valores almacenados actuales. |
>
> Cada campo en `fields`:
>
> | Campo | Requerido | Tipo | Descripción |
> | - | - | - | - |
> | `name` | Sí | string | Clave del campo. |
> | `type` | Sí | string | `TEXT`, `SELECT`, `IMAGE` o `LIST`. |
> | `label` | No | object | Etiqueta localizada opcional por locale. |
> | `required` | No | boolean | Si el campo es obligatorio. |
> | `placeholder` | No | string | Texto placeholder opcional. |
> | `options` | No | array | Para campos `SELECT` — objetos con `label` y `value`. |
> | `altText` | No | string | Para campos `IMAGE` — texto alternativo. |
> | `src` | No | string | Para campos `IMAGE` — URL de la imagen. |
> | `href` | No | string | Para campos `IMAGE` — URL de enlace opcional. |
> | `value` | No | varies | Valor almacenado actual para este canal. Omitido cuando está vacío. |

## Respuestas de error

| Estado | Descripción |
| - | - |
| `401` | Access token ausente o inválido. |
| `403` | El token no incluye el scope `channels:read`. |
| `404` | No existe un canal con el `id` indicado. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.