XPipe LogoXPipe Documentation

Get category info

Queries detailed information about categories.

POST
/category/info

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired
categoriesRequiredarray<string>

The categories

curl -X POST "http://localhost:21721/category/info" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [
      "97458c07-75c0-4f9d-a06e-92d8cdf67c40"
    ]
  }'

The query was successful. The body contains the detailed category information.

{
  "summary": "Single category information",
  "value": {
    "infos": [
      {
        "category": "97458c07-75c0-4f9d-a06e-92d8cdf67c40",
        "parentCategory": "bfb0b51a-e7a3-4ce4-8878-8d4cb5828d6c",
        "name": [
          "all connections",
          "default"
        ],
        "lastUsed": "2024-05-31T11:53:02.408504600Z",
        "lastModified": "2024-06-23T21:15:25.608097Z",
        "config": {}
      }
    ]
  }
}