---
title: "Returns all rule groups of the user returned in a basic auto-complete array."
method: GET
path: "/v1/autocomplete/rule-groups"
tags: ["autocomplete"]
---

# Returns all rule groups of the user returned in a basic auto-complete array.

`GET /v1/autocomplete/rule-groups`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/autocomplete/rule-groups`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

## Query parameters

- `query` string, string
- `limit` integer

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of rule groups with very basic information.

- AutocompleteRuleGroup[]
  - `id` string, string, required
  - `name` string, string, required: Name of the rule group found by an auto-complete search.
  - `description` string, string: Description of the rule group found by auto-complete.
  - `active` boolean: Is the bill active or not?

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `422`: Validation error. The body will have the exact details.
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-0.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-0/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-0/revisions/445332924ac5?raw)