---
title: "Query categories"
method: POST
path: "/category/query"
---

# Query categories

`POST /category/query`

## Request

- Base URL: `http://localhost:21721`
- URL: `http://localhost:21721/category/query`
- Auth: HTTP bearer

Queries all categories using a filter.

The filter supports globs and can match the category names.
All matching is case insensitive.

## Request body

- CategoryQueryRequest
  - `filter` string, required: The filter string to match category names. Category names are delimited by / if they are hierarchical. The filter supports globs.

## Response `200`

The query was successful. The body contains all matched categories.

- CategoryQueryResponse
  - `found` string[], required: The found categories

## Other responses

- `400`: Bad request. Please check error message and your parameters.
- `401`: Authorization failed. Please supply a `Bearer` token via the `Authorization` header.
- `403`: Authorization failed. Please supply a valid `Bearer` token via the `Authorization` header.
- `500`: Internal error.

---

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