XPipe LogoXPipe Documentation

Query categories

Queries all categories using a filter. The filter supports globs and can match the category names. All matching is case insensitive.

POST
/category/query

Authorization

AuthorizationRequiredBearer <token>

The bearer token used is the session token that you receive from the handshake exchange.

In: header

Request Body

application/jsonRequired
filterRequiredstring

The filter string to match category names. Category names are delimited by / if they are hierarchical. The filter supports globs.

curl -X POST "http://localhost:21721/category/query" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": "**"
  }'

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

{
  "summary": "Matched categories",
  "value": {
    "found": [
      "97458c07-75c0-4f9d-a06e-92d8cdf67c40"
    ]
  }
}