Get patient tag by ID

Request

Retrieve a single tag belonging to the patient.

Security

PartnerApiKey and PartnerOAuth

Path

patientIdinteger, (int64)required

Patient ID (AccountPatient id)

tagIdinteger, (int64)required

Tag ID

accountIdinteger, (int64)required

Account identifier

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

Responses

Tag found and returned successfully

Bodyapplication/json

activeboolean

Whether the tag is active. false indicates a removed tag.

Example:true

colorstring

Tag color (hex code from the Lobbie palette)

Example:"#C1E4FF"

createdAtstring, (date-time)

When the tag was created

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

idinteger, (int64)

Unique tag identifier

Example:55

notestring

Tag text

Example:"VIP"

patientIdinteger, (int64)

Patient ID this tag belongs to

Example:12345

sortOrderinteger, (int64)

Display order (ascending)

Example:10000

updatedAtstring, (date-time)

When the tag was last updated

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

Response

{
  "active": true,
  "color": "#C1E4FF",
  "createdAt": "2025-01-15T14:00:00Z",
  "id": 55,
  "note": "VIP",
  "patientId": 12345,
  "sortOrder": 10000,
  "updatedAt": "2025-01-15T14:00:00Z"
}