List a template's StaffNotifications

get

https://api.vcita.biz/v3/communication/staff_notifications

Overview

Return one page of the StaffNotifications that were created from one notification template.

Use it to get the delivery statuses of many StaffNotifications with one request per page, instead of one request per StaffNotification.

Filters

Every filter is a query parameter. notification_template_code_name is required. Unknown query parameters are ignored.

Incremental sync

Pass the highest updated_at that you already have as updated_since. The bound is inclusive, so a StaffNotification on the boundary can be returned again. De-duplicate the rows by uid.

Paging

To read every page, pass the next_cursor of each response as cursor, with the same filters and sort. Stop when next_cursor is null. When a StaffNotification changes between two requests, paging with page can skip another StaffNotification. The cursor does not skip one.

The response has no total count.

Only the creator of the notification template can list its StaffNotifications.

Available for Directory and Application tokens. The token must be the one that created the notification template.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

notification_template_code_name

string

required

The code name of the notification template whose StaffNotifications to return (e.g., "campaign_abc123")

updated_since

date-time

Return only StaffNotifications updated at or after this ISO 8601 time. Inclusive (e.g., "2026-09-09T05:30:21.000Z")

updated_before

date-time

Return only StaffNotifications updated before this ISO 8601 time. Exclusive (e.g., "2026-09-10T00:00:00.000Z")

pane_status

string

enum

Return only StaffNotifications whose pane notification has this status. Both values require that the pane notification was sent (e.g., "sent", "read")

Allowed:

push_clicked

boolean

Return only StaffNotifications sent by push, whose push notification was clicked (true) or was not clicked (false) (e.g., true, false)

sort

string

enum

Defaults to updated_at:asc

Sort order. Rows with the same updated_at always come in the same order (e.g., "updated_at:asc", "updated_at:desc")

Allowed:

cursor

string

Return the page after the page that returned this cursor. Use the next_cursor of the previous response, with the same filters and sort. Cannot be used with page (e.g., "WyIyMDI2LTA5LTA5IDA1OjMxOjEyLjAwMDAwMCIsNDJd")

page

integer

≥ 1

Defaults to 1

The page number. Cannot be used with cursor (e.g., 1, 2)

per_page

integer

1 to 100

Defaults to 25

How many StaffNotifications to return per page. The maximum is 100 (e.g., 25, 100)

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200StaffNotifications retrieved successfully

400A filter or query parameter is not valid, cursor is used with page, the notification template does not exist, or the token is not the creator of the template

401The token is missing, or its type is not Directory or App

500Internal server error