CoworkerReminderAudits
Search CoworkerReminderAudits
Search and list CoworkerReminderAudit records with filtering, sorting, and pagination.
GET
Search CoworkerReminderAudits
A CoworkerReminderAudit records when a reminder was sent to a customer at a location. Each entry links the customer to the reminder that was triggered, forming an internal audit trail of automated communications that have been dispatched.
Use these records to determine which reminders have already been sent to a specific customer, and to avoid sending duplicate communications.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerReminderAudit-List role.Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the customer the reminder was sent to.
string
Filter by full name of the customer the reminder was sent to.
integer
Filter by iD of the reminder that was sent.
string
Filter by name of the reminder that was sent.
Range Filters
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
CoworkerReminderAudit[]
The list of CoworkerReminderAudit records matching the query. See the Get one CoworkerReminderAudit endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response
Search CoworkerReminderAudits