Categorias

Lista categorias do workspace da chave

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.

get/api/v1/categories

Request

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

Query parameters

workspace_idinteger

Workspace a consultar, entre os autorizados para esta chave (ver GET /api/v1/workspaces). Se omitido, usa o workspace padrão da chave. Um id fora do conjunto autorizado resulta em 400 INVALID_WORKSPACE. Só é possível autorizar (em /integrations) um workspace do qual o dono da chave já é membro — para incluir dados de um workspace de outra pessoa, ela precisa primeiro compartilhar esse workspace com você (convite em /workspaces), não basta saber o id.

include_ignorable_categoriesboolean

Se true, inclui as categorias fora dos totais (ex.: Ignorado, Pagamento de Cartão de Crédito, Investimentos, e as subcategorias delas). Padrão false.

Response

Lista de categorias

Example response

{
  "data": [
    {
      "category": "Alimentação"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.