---
title: "List notification queue entries"
method: GET
path: "/api/servicetodo/processes/notification-queue"
tags: ["notificationQueue"]
---

# List notification queue entries

`GET /api/servicetodo/processes/notification-queue`

## Request

- Base URL: `https://services.fountain.com`
- URL: `https://services.fountain.com/api/servicetodo/processes/notification-queue`
- Auth: HTTP bearer

## Query parameters

- `filter` object
  - `workerUuid` union: Filter to one worker (string) or multiple workers (array of UUIDs).
    - string, uuid: Single worker UUID
    - string[]: One or more worker UUIDs
  - `taskFlowUuid` union: Filter to one or more onboarding flows.
    - string, uuid
    - string[]
  - `search` string: Partial, case-insensitive match on the worker's name.
  - `scheduledFrom` string, date-time: Inclusive lower bound on the scheduled time (ISO 8601). The caller computes it from the viewer local calendar.
  - `scheduledTo` string, date-time: Exclusive upper bound on the scheduled time (ISO 8601). One day is `scheduledFrom` = its midnight and `scheduledTo` = the next midnight. Must be after `scheduledFrom`; otherwise the endpoint answers 400.
  - `status` union: Filter by the UI-facing status bucket (upcoming/sent/cancelled/skipped) — not the raw backend status.
    - 'upcoming' | 'sent' | 'cancelled' | 'skipped'
    - string[]
  - `pagination` object
    - `page` integer
    - `limit` integer

## Response `200`

Returns a paginated page of notification queue entries.

- object
  - `data` object, required
    - `data` object[], required
      - `uuid` string, uuid, required
      - `workerUuid` string, uuid, required
      - `workerDisplayName` string, required
      - `taskFlowUuid` string, uuid, required
      - `notificationType` 'initial' | 'deadline' | 'reminder' | 'newTask' | 'adHoc' | 'flowCompleted' | 'flowUpdated' | 'deadlineMissed', required
      - `channel` 'email' | 'sms', required
      - `status` 'upcoming' | 'sent' | 'cancelled' | 'skipped', required: The UI-facing status bucket (upcoming/sent/cancelled/skipped) — never the raw backend status.
      - `scheduledAt` string, date-time, required: ISO 8601 UTC. Converting to the viewer local timezone is a UI concern.
      - `sentAt` string, date-time, nullable, required
      - `cancelReason` 'workerTerminated' | 'workerOutOfTaskflow' | 'taskflowArchived' | 'taskflowCompleted' | 'taskflowSuperseded' | 'channelDisabled' | 'membershipGone' | 'workerLeftFlow' | 'workerAlreadyStarted': Why the notification was cancelled, when the cancel recorded a reason. Absent otherwise: an admin cancel records none.
    - `pagination` object, required
      - `page` integer, required
      - `limit` integer, required
      - `total` integer, required
  - `meta` ResponsesPartMeta, required
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `capped` boolean: The server lowered filter[limit] to its ceiling. Page with filter[skip] to read past it.
    - `status` string
    - `duration` number
    - `size` number

## Other responses

- `422`: default error response

---

[API](https://skmtc.dev/fountain/apis/worker-experience-public-api.md) - [All operations](https://skmtc.dev/fountain/apis/worker-experience-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fountain/apis/worker-experience-public-api/revisions/6b9a31f79e22?raw)