GET/me.json

Get Current User Details

Returns the details for the account you're currently logged in with.


Query Params

  • Name
    getPreferences
    Type
    boolean
    Description

    Get user preferences in teamwork projects, eg. ordering of comments.

    Default
    false
  • Name
    fullProfile
    Type
    boolean
    Description

    Get additional user details.

    Default
    false
  • Name
    getDefaultFilters
    Type
    boolean
    Description
    Default
    false
  • Name
    sharedFilter
    Type
    boolean
    Description
    Default
    false
  • Name
    getAccounts
    Type
    boolean
    Description
    Default
    false
  • Name
    includeAuth
    Type
    boolean
    Description

    Includes API key, please be careful sharing this data.

    Default
    false
  • Name
    cleanPreferences
    Type
    boolean
    Description
    Default
    false
  • Name
    includeClockIn
    Type
    boolean
    Description
    Default
    false
  • Name
    includeTeamIds
    Type
    boolean
    Description
    Default
    false
  • Name
    includeCompanyTimesheetsPermissions
    Type
    boolean
    Description
    Default
    false
  • Name
    getNumActiveProjects
    Type
    boolean
    Description
    Default
    false

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "person": {
    "administrator": true,
    "pid": "",
    "site-owner": false,
    "twitter": "",
    "phone-number-home": "",
    "last-name": "User",
    "email-address": "me@demo1company.com",
    "profile": "",
    "userUUID": "",
    "user-name": "test",
    "id": "999",
    "company-name": "Demo 1 Company",
    "last-changed-on": "2014-03-31T10:23:46Z",
    "phone-number-office": "",
    "deleted": false,
    "privateNotes": "",
    "phone-number-mobile": "",
    "first-name": "Demo",
    "user-type": "account",
    "permissions": {
      "administrator": true,
      "can-manage-people": true,
      "can-add-projects": true,
      "can-access-templates": true,
      "has-access-to-new-projects": true,
      "isAdminOnAProject": true,
      "canAccessCalendar": true,
      "canAccessCustomReports": true,
      "canAccessPortfolio": true,
      "canAddCustomReports": true,
      "canApproveTime": true,
      "canEditWorkflows": true,
      "canManageCustomFields": true,
      "canManageFixedFeeBudgets": true,
      "canManagePortfolio": true,
      "canManageProjectTemplates": true,
      "canManagePublicHolidays": true,
      "canManageQuotes": true,
      "canManageSchedule": true,
      "canManageTimeReminders": true,
      "canViewProjectTemplates": true,
      "canViewSchedule": true,
      "canViewWorkflows": true
    },
    "im-service": "",
    "address": {
      "zipcode": "",
      "countrycode": "",
      "state": "",
      "line1": "",
      "country": "",
      "line2": "",
      "city": ""
    },
    "im-handle": "",
    "created-at": "2013-10-21T18:01:39Z",
    "phone-number-office-ext": "",
    "company-id": "999",
    "has-access-to-new-projects": false,
    "phone-number-fax": "",
    "avatar-url": "https://s3.amazonaws.com/TWFiles/2/users/999.avatar",
    "in-owner-company": "1",
    "last-login": "2014-04-01T11:32:12Z",
    "email-alt-1": "",
    "email-alt-2": "",
    "email-alt-3": "",
    "companyId": "999",
    "title": "",
    "companyRoleId": "0",
    "lengthOfDay": "8",
    "utilizationTarget": "0.6",
    "textFormat": "HTML",
    "phone-number-mobile-parts": {
      "prefix": "",
      "countryCode": "",
      "phone": ""
    },
    "private-notes": "",
    "profile-text": "",
    "notes": "",
    "APIEnabled": true,
    "twoFactorAuthEnabled": false,
    "isClientUser": false,
    "has-desk-account": true,
    "useShorthandDurations": false,
    "isClockedIn": false,
    "teamIds": [
      "3690",
      "3692",
      "3694"
    ],
    "companyTimesheetsPermissions": {
      "canAccess": true
    },
    "tags": [],
    "workingHours": {
      "monday": {
        "startTime": "09:00:00",
        "endTime": "17:00:00",
        "taskHours": "8",
        "timezone": "Europe/Dublin"
      },
      "tuesday": {
        "startTime": "09:00:00",
        "endTime": "17:00:00",
        "taskHours": "8",
        "timezone": "Europe/Dublin"
      },
      "wednesday": {
        "startTime": "09:00:00",
        "endTime": "17:00:00",
        "taskHours": "8",
        "timezone": "Europe/Dublin"
      },
      "thursday": {
        "startTime": "09:00:00",
        "endTime": "17:00:00",
        "taskHours": "8",
        "timezone": "Europe/Dublin"
      },
      "friday": {
        "startTime": "09:00:00",
        "endTime": "17:00:00",
        "taskHours": "8",
        "timezone": "Europe/Dublin"
      },
      "saturday": "",
      "sunday": ""
    },
    "localization": {
      "language": "English",
      "languageCode": "EN",
      "timezone": "Dublin",
      "timezoneId": "72",
      "timezoneJavaRefCode": "Europe/Dublin",
      "timezoneUTCOffsetMins": "60",
      "dateFormat": "dd/mm/yyyy",
      "dateFormatId": "1",
      "timeFormat": "HH:MM",
      "timeFormatId": "2",
      "start-on-sunday": false
    },
    "notifications": {
      "notify-on-status-update": false,
      "notify-on-task-complete": false,
      "notify-on-added-as-follower": false,
      "receive-my-notifications-only": false,
      "receive-notify-warnings": false,
      "sound-alerts-enabled": false,
      "receive-daily-reports": false,
      "receive-daily-reports-if-empty": false,
      "receive-daily-reports-at-weekend": false,
      "receive-daily-reports-at-time": "5",
      "daily-report-days-filter": "14",
      "daily-report-sort-by": "PROJECT",
      "receiveTimeApprovalsEmails": false
    },
    "integrations": {
      "microsoftConnector": {
        "enabled": false
      }
    },
    "social": {
      "linkedin": "",
      "facebook": "",
      "twitter": "",
      "website": ""
    },
    "home-tabs": [
      {
        "tabIdentifier": "activity",
        "pendoLabel": "activity",
        "icon": "lsi-numbered-list",
        "path": "/home/activity",
        "url": "null",
        "embedCode": "null",
        "draggable": "1",
        "enabled": "1",
        "displayOrder": "5"
      }
    ],
    "auth": {
      "token": "REDACTED",
      "apikey": "REDACTED",
      "timestamp": "01/04/2014 11:32:12"
    },
    "preferences": {
      "sidebarTheme": "dark",
      "shouldMinimizeSidebar": false,
      "project-tasks-view-mode": "gantt",
      "commentThreadSort": "asc",
      "itemCommentsSortOrder": "asc",
      "taskSkipWeekends": true,
      "calendarShowWeekend": true,
      "defaultDashboardId": "264",
      "todays-tasks-display-option": "0",
      "late-upcoming-display-option": "1",
      "filterSidebarVisible": true,
      "webBNotifsOn": true
    },
    "defaultFilters": {
      "homeActivity": {
        "id": "131526",
        "section": "homeActivity",
        "userId": "999",
        "projectId": "0",
        "title": "",
        "shared": false,
        "parameters": {
          "projectIds": "",
          "userIds": "",
          "activityTypes": ""
        }
      }
    }
  },
  "STATUS": "OK"
}