Get category transition by ID

Request

Retrieve detailed information about a specific category transition.

Security

PartnerApiKey and PartnerOAuth

Path

patientIdinteger, (int64)required

Patient ID (AccountPatient id)

transitionIdinteger, (int64)required

Transition ID

accountIdinteger, (int64)required

Account identifier

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

Responses

Category transition found and returned successfully

Bodyapplication/json

categoryColorstring

Category color (hex code)

Example:"#4CAF50"

categoryIdinteger, (int64)

Category definition ID for this enrollment

Example:111

categoryNamestring

Category name

Example:"Active Patient"

changedBystring

Staff member who made the change (if manual)

Example:"Jane Smith"

fromCrmStatusColorstring

Previous CRM status color (hex code)

Example:"#2196F3"

fromCrmStatusIdinteger, (int64)

Previous CRM status ID (null on initial assignment)

Example:10

fromCrmStatusNamestring

Previous CRM status name

Example:"New"

idinteger, (int64)

Unique transition identifier

Example:12345

patientCategoryIdinteger, (int64)

Patient category enrollment ID this transition applies to

Example:55

patientIdinteger, (int64)

Patient ID

Example:67890

toCrmStatusColorstring

New CRM status color (hex code)

Example:"#4CAF50"

toCrmStatusIdinteger, (int64)

New CRM status ID

Example:11

toCrmStatusNamestring

New CRM status name

Example:"Qualified"

transitionedAtstring, (date-time)

When the transition occurred

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

Response

{
  "categoryColor": "#4CAF50",
  "categoryId": 111,
  "categoryName": "Active Patient",
  "changedBy": "Jane Smith",
  "fromCrmStatusColor": "#2196F3",
  "fromCrmStatusId": 10,
  "fromCrmStatusName": "New",
  "id": 12345,
  "patientCategoryId": 55,
  "patientId": 67890,
  "toCrmStatusColor": "#4CAF50",
  "toCrmStatusId": 11,
  "toCrmStatusName": "Qualified",
  "transitionedAt": "2025-01-15T14:00:00Z"
}