> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fire.rest/llms.txt
> Use this file to discover all available pages before exploring further.
# Channels config
> Read the active sales-channel configuration (with fulfillment types) for your vendor. Use it to know which channels and fulfillment combinations your integration can use.
Returns the full sales-channel configuration for your vendor, enriched with global catalog data (`uuid`, `name`, `description`) and the fulfillment types configured for each channel.
The endpoint takes no query parameters. Only channels with `enabled !== false` are returned. Channels that have no match in the catalog are excluded from the response.
## Authentication
Your Fire API key with the `channels:read` scope. The key **must be vendor-scoped** (account + vendor binding) — keys without a `vendorId` are rejected with `403`. The account and vendor are resolved from the key, so no `account` header or query param is needed.
## Request
```http theme={null}
GET https://api.fire.rest/api/v1/fire/external/channels/config
x-api-key:
```
## Response
UUID of the account the API key belongs to.
ISO 3166-1 alpha-2 (e.g. `BR`, `EC`, `CO`).
Vendor identifier.
Human-readable vendor name.
UUID from the global `channels` catalog.
Channel code (e.g. `APP`, `KIOSK`, `WEB`).
Display name.
Optional description.
Always `true` for returned rows.
UUID from the global `fulfillment_types` catalog.
Fulfillment code (e.g. `DELIVERY`, `PICKUP`).
Display name.
Internal reference name.
Optional description.
Always `true` for returned rows.
```json 200 theme={null}
{
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"countries": [
{
"countryCode": "EC",
"vendors": [
{
"vendorId": "100.1.10",
"vendorName": "Sandbox Ecuador",
"channels": [
{
"uuid": "9f3a-...-e1",
"code": "APP",
"name": "Mobile App",
"description": "Mobile-app sales channel",
"enabled": true,
"fulfillmentTypes": [
{
"uuid": "abcf-...-2d",
"code": "DELIVERY",
"name": "Delivery",
"referenceName": "DELIVERY",
"description": null,
"enabled": true
}
]
},
{
"uuid": "7e2b-...-c8",
"code": "KIOSK",
"name": "Kiosk",
"description": null,
"enabled": true,
"fulfillmentTypes": []
}
]
}
]
}
]
}
```
```json 401 — invalid API key theme={null}
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
```
```json 403 theme={null}
{
"error": {
"code": "forbidden",
"message": "Access denied"
}
}
```
## Notes
* `uuid` comes from the global `channels` catalog, not from the per-account JSONB.
* `fulfillmentTypes` only includes types configured for that channel in the vendor. Types without a catalog match are excluded.
* `countries` groups by country code from the JSONB. A vendor may appear in multiple countries if it is configured per-country.
## Related
Companion endpoint to read configured payment methods.
How vendor-scoped API keys and scopes work.