Skip to content

Get notification by ID

Request

Retrieve detailed information about a specific notification.

Security
PartnerApiKey and PartnerOAuth
Path
notificationIdinteger, (int64)required

Notification ID

Example:12345
accountIdinteger, (int64)required

Account identifier

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

Responses

Notification found and returned successfully

Bodyapplication/json
appointmentIdinteger, (int64)

Related appointment ID if applicable

Example:111
createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
emailProcessedAtstring, (date-time)

When the email was processed

Example:"2025-01-15T09:00:05Z"
emailStatusstring

Email delivery status

Enum:"UNPROCESSED""PROCESSED_SENT""PROCESSED_UNSENT"
Example:"PROCESSED_SENT"
formGroupIdinteger, (int64)

Related form group ID if applicable

Example:222
idinteger, (int64)

Unique notification identifier

Example:12345
notificationGroupIdinteger, (int64)

Notification group ID this notification belongs to

Example:999
patientIdinteger, (int64)

Patient ID who received the notification

Example:67890
scheduledAtstring, (date-time)

When the notification is scheduled to be sent

Example:"2025-01-15T09:00:00Z"
smsProcessedAtstring, (date-time)

When the SMS was processed

Example:"2025-01-15T09:00:05Z"
smsStatusstring

SMS delivery status

Enum:"UNPROCESSED""PROCESSED_SENT""PROCESSED_UNSENT"
Example:"PROCESSED_SENT"
typestring

Notification type

Enum:"STAFF_WELCOME""PATIENT_WELCOME""APPOINTMENT_CONFIRMATION""APPOINTMENT_CHECKIN""APPOINTMENT_RESCHEDULE""APPOINTMENT_SCHEDULE_DATE""APPOINTMENT_SCHEDULE_TIME""APPOINTMENT_ROOM_READY""PASSWORD_RESET""APPOINTMENT_SCHEDULED"
Example:"APPOINTMENT_CONFIRMATION"
Response
{
  "appointmentId": 111,
  "createdAt": "2025-01-15T14:00:00Z",
  "emailProcessedAt": "2025-01-15T09:00:05Z",
  "emailStatus": "PROCESSED_SENT",
  "formGroupId": 222,
  "id": 12345,
  "notificationGroupId": 999,
  "patientId": 67890,
  "scheduledAt": "2025-01-15T09:00:00Z",
  "smsProcessedAt": "2025-01-15T09:00:05Z",
  "smsStatus": "PROCESSED_SENT",
  "type": "APPOINTMENT_CONFIRMATION"
}