REST API: List Effective Settings

Last Updated: May 16, 2017

Description

Retrieves a list of all effective settings associated with a single user, with optional filters to narrow down the results.

Resource Information

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

Available Filters

user_id:
optional
Integer. User id for whom you'd like to retrieve effective settings. If none is specified, the currently logged in user's id will be used. Only effective settings that apply to this user_id will be returned. An admin will see more settings than a regular user will.
modified_before:
optional
String (ISO8601 format). Only sections with settings modified before this date/time will be returned (i.e. 2004-02-12T15:19:21+00:00).
modified_since:
optional
String (ISO8601 format). Only sections with settings modified since this date/time will be returned (i.e. 2004-02-12T15:19:21+00:00).

Examples

Retrieve a list of all effective settings for user_id 1234.
Note: In order to perform these operations on your TSheets account, you will need to replace the user_id with that of an employee on your account.

## REQUEST
curl -H "Authorization: Bearer <Access-Token>" -i "https://rest.tsheets.com/api/v1/effective_settings?user_id=1234"

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

{
 "results": {
  "effective_settings": {
   "general": {
    "settings": {
     "calculate_overtime": "1",
     "clockout_override": 1,
     "clockout_override_hours": 10,
     "clockout_override_notify_admin": 1,
     "clockout_override_notify_mgrs": 0,
     "daily_doubletime": "1",
     "daily_doubletime_hours": "12",
     "daily_overtime": "1",
     "daily_regular_hours": "8",
     "date_locale": "us",
     "emp_panel": 1,
     "emp_panel_email": 1,
     "emp_panel_passwd": 1,
     "emp_panel_pto_ledger": "1",
     "emp_panel_tz": 1,
     "employee_pto_entry": "1",
     "enable_timesheet_notes": "1",
     "hide_working_time": "0",
     "jc_label": "Customer",
     "lunch_deduct": 0,
     "lunch_length": 1,
     "lunch_threshold": 9,
     "max_customfielditems": "-1",
     "max_jobcodes": "-1",
     "payroll_end_date": "2015-01-04",
     "payroll_first_end_day": "1",
     "payroll_last_end_day": "16",
     "payroll_month_end_day": "1",
     "payroll_type": "monthly",
     "pto_entry": "1",
     "pto_overtime": 0,
     "seventh_consecutive_dt": "1",
     "simple_clockin": 0,
     "time_format": "24",
     "timecard_fields": "JOBCODE,91,89",
     "timesheet_edit_notes_for_all_users": 0,
     "timesheet_notes_notify_admin": 0,
     "timesheet_notes_notify_mgrs": 0,
     "timesheet_notes_required": 0,
     "tz": "America\/Boise",
     "week_start": "1",
     "weekly_regular_hours": "40"
    },
    "last_modified": "2017-05-03T20:14:28+00:00"
   },
   "alerts": {
    "settings": {
     "installed": 0
    },
    "last_modified": "2001-01-01T12:00:00+00:00"
   },
   "approvals": {
    "settings": {
     "employee_approval_required": "0",
     "employee_approval": "1",
     "installed": "1",
     "employee_reminders_based_on": "payroll_close_date"
    },
    "last_modified": "2017-05-15T19:48:01+00:00"
   },
   "breaks": {
    "settings": {
     "installed": "1"
    },
    "last_modified": "2017-05-03T20:14:28+00:00"
   },
   "dialin": {
    "settings": {
     "installed": "1",
     "languages": "english",
     "require_emp_num": "1"
    },
    "last_modified": "2017-05-03T20:14:28+00:00"
   },
   "rounding": {
    "settings": {
     "round_out_min": "1",
     "round_out_direction": "nearest",
     "round_out": "1",
     "round_in_min": "1",
     "round_in_direction": "nearest",
     "installed": "1",
     "round_in": "1"
    },
    "last_modified": "2017-05-03T20:14:28+00:00"
   },
   "schedule": {
    "settings": {
     "installed": "1",
     "drafted_first_schedule_event_occurred": "1",
     "published_first_schedule_event_occurred": "1",
     "trial_expiration_date": "2016-05-26",
     "learning_step": "5",
     "view_schedule_permission": "company",
     "manage_schedule_permission": "company",
     "employee_view": "company",
     "manager_view": "company"
    },
    "last_modified": "2017-05-15T19:48:31+00:00"
   },
   "twitter": {
    "settings": {
     "installed": 0
    },
    "last_modified": "2001-01-01T12:00:00+00:00"
   },
   "schedule": {
    "settings": {
     "installed": "1",
     "auto_show_try_schedule3_beta_callout": "0",
     "business_hours_end": "17:00:00",
     "business_hours_start": "08:00:00",
     "drafted_first_schedule_event_occurred": "1",
     "hidden_days": "",
     "hide_totals": "0",
     "view_schedule_permission": "company",
     "manage_schedule_permission": "company",
     "published_first_schedule_event_occurred": "1",
     "trial_expiration_date": "2017-03-14",
     "week_start": "Sun",
     "learning_step": "10",
     "suppress_draft_publish_notice": "1",
     "suppress_team_ssb_notice": "1",
     "suppress_team_ssb_switch_notice": "1"
    },
    "last_modified": "2017-05-08T16:57:04+00:00"
   }
  }
 }
}
    

Retrieve a list of all effective settings modified since March 1st, 2013. Currently logged in user's id will be used, because none is specified in the request.

    ## REQUEST
    curl -H "Authorization: Bearer <Access-Token>" -i "https://rest.tsheets.com/api/v1/effective_settings?modified_since=2013-03-01T00:00:00-0600"

    ## RESPONSE
    ## (response would have the same layout as the above examples)