---
title: "Listar coleções"
method: GET
path: "/{alias}/catalog/collections"
tags: ["Catálogo - Coleções"]
---

# Listar coleções

`GET /{alias}/catalog/collections`

Lista todas as coleções. Use o parâmetro `onlyParents=true` para listar apenas as coleções pai

## Path parameters

- `alias` string, required

## Query parameters

- `includes` 'products' | 'banners' — Pode incluir 'products' e/ou 'banners'
- `onlyParents` boolean

## Response `200`

Lista de coleções

- object — Representa uma paginação com meta
  - `data` Collection[]
    - `id` integer
    - `parent_id` integer
    - `active` boolean
    - `show_banners` boolean
    - `featured` boolean
    - `is_promotional` boolean
    - `name` string
    - `visible_products` integer
    - `home` boolean
    - `expired` boolean
    - `slug` string
    - `description` string
    - `seo_title` string
    - `seo_keywords` string
    - `seo_description` string
    - `path` string — Caminho relativo para o recurso.
    - `expire_in` string — Tempo restante até a expiração, descrito em formato textual (ex.: 'dentro de 998 anos').
    - `total_products` integer — Número total de produtos relacionados ao recurso.
  - `meta` object
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
      - `links` object
        - `previous` string
        - `next` string

## Other responses

- `400` — Requisição inválida

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/versions/fa16c50bef09/schema)