Lunch Money V2 icon

Lunch Money V2

Interact with the Lunch Money v2 API — transactions, budgets, categories, accounts and more

Categories → Get All Categories

AI-generated

Summary

Retrieve all categories for the current user, optionally filtering to include only category groups and specifying the format of the returned data.

Inputs

  • Format — Specify the format of the returned categories as 'Nested', 'Flattened', or leave unset to use the default nested structure.
  • Is Group — Boolean to filter results to only include category groups if true; defaults to false (returns all categories).

Output shape

a list of category objects representing the user's categories as returned by the Lunch Money API.

The output can be formatted as nested or flattened based on the 'Format' option. Filtering by category groups is controlled by the 'Is Group' boolean. The API request is a GET to '/categories' with query parameters 'format' and 'is_group'. No pagination indicated.

Examples

Example 1: Retrieve all categories in nested format

Set 'Format' to 'Nested' and 'Is Group' to false or leave default.

Example 2: Retrieve only category groups in flattened format

Set 'Format' to 'Flattened' and 'Is Group' to true.

Links

Discussion