---
title: "Lista categorias do workspace da chave"
method: GET
path: "/api/v1/categories"
tags: ["Categorias"]
---

# Lista categorias do workspace da chave

`GET /api/v1/categories`

## Request

- Base URL: `https://snabber.com.br`
- URL: `https://snabber.com.br/api/v1/categories`
- Auth: HTTP bearer

Retorna as categorias de transação do workspace vinculado à chave de API, com limite mensal, ícone e grupo de DRE (`dre_group`, quando definido — aplicável apenas a workspaces compartilhados/empresa). Categorias podem ter subcategorias: `parent_id` aponta para a categoria pai (null = raiz), e uma transação pode estar tanto na pai quanto numa subcategoria. `totals_mode` diz como a categoria entra nos totais (só a raiz guarda; a subcategoria herda do pai). Por padrão omite as categorias fora dos totais (ex.: Ignorado, Pagamento de Cartão de Crédito, Investimentos) — use `include_ignorable_categories=true` para trazê-las.

## Query parameters

- `workspace_id` integer
- `include_ignorable_categories` boolean

## Response `200`

Lista de categorias

- CategoryList
  - `data` Category[]
    - `id` integer
    - `category` string
    - `monthly_limit` number, nullable
    - `icon_url` string, nullable
    - `dre_group` 'receita_bruta' | 'deducoes' | 'custos' | 'despesas_operacionais' | 'resultado_financeiro' | 'nao_operacional' | 'null', nullable: Grupo do DRE, apenas quando definido e o workspace suporta DRE (compartilhado/empresa)
    - `parent_id` integer, nullable: Id da categoria pai, quando esta é uma subcategoria; null para categoria raiz.
    - `totals_mode` 'include' | 'toggle' | 'never' | 'cash_only': Como a categoria entra nos totais: 'include' normal; 'toggle' fora por padrão (volta com include_ignorable_categories); 'never' nunca soma; 'cash_only' só na visão de caixa (pagamento de fatura). Só a categoria raiz guarda; a subcategoria herda o do pai (e aqui vem sempre include).
  - `meta` object
    - `workspace_id` integer

## Other responses

- `401`: Chave de API ausente, inválida, revogada ou expirada
- `403`: Plano do usuário não tem acesso à API (downgrade para free)
- `429`: Limite de requisições excedido

---

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