REST API: List Reminders

Last Updated: November 07, 2016

Description

Retrieves a list of reminders associated with your employees or company, with filters to narrow down the results.

Resource Information

HTTP Method GET
Endpoint https://rest.tsheets.com/api/v1/reminders
Authentication Token header required. See authentication section
Request format Everything is handled through the request uri on a GET.
Response format json
Response object Reminder

Available Filters

user_ids:
required
Integer. Comma-separated list of one or more user ids to retrieve reminders for. Include a user_id of 0 to retrieve company-wide reminders.
reminder_types:
optional
String. Comma-separated list of one or more reminder types to retrieve reminders for. Current legal values are 'clock-in' and 'clock-out'. For example, specify 'clock-in,clock-out' to retrieve both clock-in and clock-out reminders.
modified_since:
optional
String (ISO8601 format). Only reminders modified since this date/time will be returned (i.e. 2004-02-12T15:19:21+00:00).
supplemental_data:
optional
String. 'yes' or 'no'. Default is 'yes'. Indicates whether supplemental data should be returned.

Examples

Retrieve company-wide and user-specific clock-in and clock-out reminders for a user.

## REQUEST
curl -H "Authorization: Bearer <Access-Token>" -i "https://rest.tsheets.com/api/v1/reminders/?user_ids=0,37&reminder_types=clock-in,clock-out""

## RESPONSE
HTTP/1.1 200 OK
Content-Type: application/json

{
 "results": {
  "reminders": {
   "72595": {
    "id": 72595,
    "reminder_type": "clock-in",
    "due_time": "23:00:00",
    "due_days_of_week": "Mon,Tue,Thu,Fri",
    "distribution_methods": "Push,SMS",
    "active": true,
    "enabled": true,
    "last_modified": "2015-07-15T19:33:57+00:00",
    "created": "2015-07-15T19:08:33+00:00",
    "user_id": 0
   },
   "72597": {
    "id": 72597,
    "reminder_type": "clock-out",
    "due_time": "04:00:00",
    "due_days_of_week": "Mon,Tue,Thu,Fri",
    "distribution_methods": "Push,SMS",
    "active": true,
    "enabled": false,
    "last_modified": "2015-07-15T19:33:57+00:00",
    "created": "2015-07-15T19:08:33+00:00",
    "user_id": 0
   },
   "72599": {
    "id": 72599,
    "reminder_type": "clock-in",
    "due_time": "13:40:00",
    "due_days_of_week": "Mon,Tue,Wed,Thu,Fri",
    "distribution_methods": "Push,SMS",
    "active": true,
    "enabled": true,
    "last_modified": "2015-07-15T19:31:43+00:00",
    "created": "2015-07-15T19:16:19+00:00",
    "user_id": 37
   },
   "72601": {
    "id": 72601,
    "reminder_type": "clock-out",
    "due_time": "17:00:00",
    "due_days_of_week": "Mon,Tue,Wed,Thu,Fri",
    "distribution_methods": "Push,SMS",
    "active": true,
    "enabled": true,
    "last_modified": "2015-07-15T19:31:43+00:00",
    "created": "2015-07-15T19:16:19+00:00",
    "user_id": 37
   }
  }
 }
}
    

Retrieve user-specific clock-in and clock-out reminders that have been modified since July 15, 2015 at 7:32pm.

## REQUEST
curl -H "Authorization: Bearer <Access-Token>" -i "https://rest.tsheets.com/api/v1/reminders/?user_ids=0,37&reminder_types=clock-in&modified_since=2015-07-15T19:32:00%2B00:00"

## RESPONSE
HTTP/1.1 200 OK
Content-Type: application/json

{
 "results": {
  "reminders": {
   "72595": {
    "id": 72595,
    "reminder_type": "clock-in",
    "due_time": "23:00:00",
    "due_days_of_week": "Mon,Tue,Thu,Fri",
    "distribution_methods": "Push,SMS",
    "active": true,
    "enabled": true,
    "last_modified": "2015-07-15T19:33:57+00:00",
    "created": "2015-07-15T19:08:33+00:00",
    "user_id": 0
   }
  }
 }
}