Notifications

List notifications

Request

Retrieve a paginated list of notifications for the account. Supports filtering by patient, notification group, type, status, and date range. Each notification tracks email and SMS delivery status independently.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

Query

patientIdinteger, (int64)

Filter by patient ID

notificationGroupIdinteger, (int64)

Filter by notification group ID

notification_typestring

Filter by 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"

emailStatusstring

Filter by email delivery status

Enum:"UNPROCESSED""PROCESSED_SENT""PROCESSED_UNSENT"

smsStatusstring

Filter by SMS delivery status

Enum:"UNPROCESSED""PROCESSED_SENT""PROCESSED_UNSENT"

startDatestring

Start of date range filter on scheduled send time (scheduledAt). ISO 8601 format.

Example:startDate=2025-01-01T00:00:00Z

endDatestring

End of date range filter on scheduled send time (scheduledAt). ISO 8601 format.

Example:endDate=2025-01-31T23:59:59Z

cursorstring

Pagination cursor from previous response

limitinteger, (int32)

Number of results per page (1-1000)

Default:20

Example:limit=20

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/notification?patientId=0&notificationGroupId=0&notification_type=STAFF_WELCOME&emailStatus=UNPROCESSED&smsStatus=UNPROCESSED&startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-01-31T23%3A59%3A59Z&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Notifications retrieved successfully

Bodyapplication/json

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

notificationsArray of objects(NotificationDTO)

List of notifications in this page

Response