List Reminders | whizboard

{
  "data": {
    "items": [
      {
        "id": 1,
        "firm_id": 1,
        "client_membership_id": 1,
        "title": "string",
        "description_html": "string",
        "due_at": "2024-01-15T09:30:00Z",
        "recurrence_type": "NONE",
        "custom_interval_days": 1,
        "monthly_day": 1,
        "status": "ACTIVE",
        "created_by_user_id": 1,
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z",
        "recipients": [
          {
            "user_id": 1,
            "user_email": "string",
            "user_name": "string",
            "delivery_role": "string"
          }
        ]
      }
    ],
    "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

client_membership_idinteger or nullOptional

statusenum or nullOptional

Lifecycle status for client reminder metadata.

Allowed values:

overdueboolean or nullOptional

recipient_user_idinteger or nullOptional

recipientstring or nullOptional>=1 character

titlestring or nullOptional>=1 character

searchstring or nullOptional>=1 character

Response

Successful Response

dataobject

statusstringOptionalDefaults to success

Errors

422

Unprocessable Entity Error