Categories

Category management for zones

List all categories

get

Responses

200

List of categories

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

colorstringOptional

createdAtstring · date-timeOptional

500

Internal server error

application/json

get/categories

HTTPcURLJavaScriptPython

GET /api/categories HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "color": "text",
    "createdAt": "2026-07-17T02:07:11.600Z"
  }
]

Create a new category

post

Body

application/json

namestringRequired

descriptionstring · nullableOptional

colorstringOptionalDefault: #3B82F6

Responses

201

Category created

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

colorstringOptional

createdAtstring · date-timeOptional

400

Bad request

application/json

409

Category already exists

500

Internal server error

application/json

post/categories

HTTPcURLJavaScriptPython

POST /api/categories HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "name": "text",
  "description": "text",
  "color": "#3B82F6"
}

{
  "id": 1,
  "name": "text",
  "description": "text",
  "color": "text",
  "createdAt": "2026-07-17T02:07:11.600Z"
}

Update a category

put

Body

application/json

idintegerRequired

namestringRequired

descriptionstring · nullableOptional

colorstringOptional

Responses

200

Category updated

application/json

idintegerOptional

namestringOptional

descriptionstring · nullableOptional

colorstringOptional

createdAtstring · date-timeOptional

400

Bad request

application/json

409

Category name conflict

500

Internal server error

application/json

put/categories

HTTPcURLJavaScriptPython

PUT /api/categories HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "id": 1,
  "name": "text",
  "description": "text",
  "color": "text"
}

{
  "id": 1,
  "name": "text",
  "description": "text",
  "color": "text",
  "createdAt": "2026-07-17T02:07:11.600Z"
}

Delete a category

delete

Query parameters

idstringRequired

Responses

200

Category deleted

No content

400

Bad request

application/json

500

Internal server error

application/json

delete/categories

HTTPcURLJavaScriptPython

DELETE /api/categories?id=text HTTP/1.1
Accept: */*

No content