Reminders
Retrieves a list of reminders associated with your employees or company.
Table Specific Information
Select
Query the Reminders table. The adapter will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the adapter.
- Id and UserId fields support the '=' and IN operators.
- ReminderType and Active fields support the '=' operator.
- LastModified field supports the <=,<,>=,>,= operators.
For example, the following queries are processed server side:
SELECT * FROM Reminders WHERE Id IN (72595, 72599) AND UserId = 37 SELECT * FROM Reminders WHERE ReminderType = 'clock-in'
Columns
| Name | Type | Description |
| Id [KEY] | Integer | Id of the reminder. |
| UserId | Integer | User id for the user that this reminder pertains to. 0 indicates that this is a company-wide reminder. |
| ReminderType | String | The type of this reminder object. Supported reminder_types are 'clock-in' and 'clock-out'. |
| DueTime | String | The 24-hour time that the reminder should be sent, expressed as 'hh:mm:ss'. |
| DueDaysOfWeek | String | A comma-separated list of the days of the week when the reminder should be sent. The value can be any combination of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri' and 'Sat'. |
| DistributionMethods | String | The message text of the notification. The maximum message length is 2000 characters. |
| Active | Boolean | If true, this reminder is active and will be evaluated at the 'due_time' and 'due_days_of_week'. If false, this reminder is inactive and will not be evaluated. If active=false for user-specific reminders, then the company-wide reminder of the same reminder type will apply. |
| Enabled | Boolean | If true, the reminder is enabled and will be sent at the 'due_time' and 'due_days_of_week'. If false, the reminder is disabled and will not be sent. A user with an active (active = true), but disabled (enabled = false) reminder will not receive that reminder type regardless of how company-wide reminders are configured. |
| Created | Datetime | Date/time when this reminder was created |
| LastModified | Datetime | Date/time when this reminder was last modified, |