Get category by ID

Request

Retrieve detailed information about a specific category.

Security

PartnerApiKey and PartnerOAuth

Path

categoryIdinteger, (int64)required

Category ID

accountIdinteger, (int64)required

Account identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/category/{categoryId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Category found and returned successfully

Bodyapplication/json

activeboolean

Whether this category is active

Example:true

colorstring

Display color (hex code)

Example:"#4CAF50"

createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

idinteger, (int64)

Unique category identifier

Example:12345

namestring

Category name

Example:"Active Patient"

patientCountinteger, (int32)

Number of patients in this category

Example:150

sortOrderinteger, (int32)

Sort order for display

Example:1

updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

Response

{
  "active": true,
  "color": "#4CAF50",
  "createdAt": "2025-01-15T14:00:00Z",
  "id": 12345,
  "name": "Active Patient",
  "patientCount": 150,
  "sortOrder": 1,
  "updatedAt": "2025-01-15T14:00:00Z"
}