List Notifications | whizboard

{
  "data": {
    "items": [
      {
        "id": 1,
        "firm_id": 1,
        "reminder_id": 1,
        "recipient_user_id": 1,
        "recipient_email": "string",
        "channel": "IN_APP",
        "status": "PENDING",
        "read_at": "2024-01-15T09:30:00Z",
        "sent_at": "2024-01-15T09:30:00Z",
        "failure_reason": "string",
        "due_at_snapshot": "2024-01-15T09:30:00Z",
        "created_at": "2024-01-15T09:30:00Z",
        "reminder_title": "string",
        "reminder_description_html": "string",
        "reminder_due_at": "2024-01-15T09:30:00Z",
        "reminder_status": "ACTIVE",
        "client_membership_id": 1
      }
    ],
    "page": 1,
    "page_size": 1,
    "total": 1,
    "total_pages": 1
  },
  "status": "success"
}

Authentication

Authorizationstring

API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

statusenum or nullOptional

Delivery/read status for reminder notifications.

Allowed values:

readboolean or nullOptional

reminder_idinteger or nullOptional

reminder_titlestring or nullOptional>=1 character

searchstring or nullOptional>=1 character

due_fromdatetime or nullOptional

due_todatetime or nullOptional

Response

Successful Response

dataobject

statusstringOptionalDefaults to success

Errors

422

Unprocessable Entity Error