Users

Get Current User

Changed on Sep 18, 2026

Retrieve the user that owns the API key. Returns every field of the team member object plus personal settings: timezone, date and time formats, time off permissions, connected integration accounts, and the full team object.

get/users/me

Request

Base URL
https://api.everhour.com
Auth
API key in header X-Api-Key
TypeScript
https://skmtc.dev/everhour/apis/everhour-api/docs/users/me/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

idnumber required

emailstring required

namestring required

headlinestring nullable

Job title. Empty string when not set.

phonestring

Omitted when not set.

externalIdstring

Employee ID from your own system, set on the member profile. Omitted when not set.

avatarUrlstring nullable

Omitted when the member has no avatar.

avatarUrlLargestring nullable

Omitted when the member has no avatar.

role'admin' | 'supervisor' | 'member' | 'member_limited' required

status'active' | 'invited' | 'pending' | 'removed' required

type'employee' | 'contractor' required

createdAtstring required

Format: Y-m-d H:i:s

isEmailVerifiedboolean required

capacityinteger nullable

Weekly capacity in seconds.

costinteger

Hourly cost in cents. Returns 0 when you lack the costs permission.

favoriteboolean required

Whether you marked this member as a favorite.

timezonenumber

UTC offset in hours (e.g. -5, 5.5).

apiKeystring

The user's personal API key — the same key used in the X-Api-Key header.

isSuspendedboolean

hasPasswordboolean

false when the user signs in through SSO or a connected account only.

dateFormatinteger

Code for the user's date format.

dateTimeFormatinteger

Code for the user's date and time format.

timeFormatinteger

Code for the user's duration format.

exportTimeFormatinteger

Code for the duration format used in exports.

exportCsvSeparatorinteger

Code for the column separator used in CSV exports.

timeRoundinginteger

Code for the rounding interval applied to time entries.

timeRoundingDirectionstring

How rounding is applied.

startPagestring

Page the user lands on after signing in.

activityModestring

countrystring

ISO 3166-1 alpha-2 country code.

notificationSettingsobject

Email and push notification preferences.

clockOutSettingsobject

Automatic clock-out preferences.

rateinteger

Hourly bill rate in cents (admins only).

Example response

{
  "id": 1304,
  "email": "john.bender@example.com",
  "name": "John Bender",
  "headline": "CEO",
  "phone": "+1 555 0100",
  "externalId": "M-3490",
  "avatarUrl": "https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d07ca81.jpg",
  "avatarUrlLarge": "https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d10830c.jpg",
  "role": "admin",
  "status": "active",
  "type": "employee",
  "createdAt": "2016-08-13 15:27:30",
  "isEmailVerified": true,
  "capacity": 144000,
  "cost": 2500,
  "groups": [
    {
      "id": 1,
      "name": "Admins"
    }
  ],
  "permissions": {
    "billingBudgets": "write",
    "userLimits": "write",
    "costs": "write",
    "invoices": "write",
    "expenses": "write"
  },
  "timeTrackingPolicy": {
    "allowTimeWithoutTask": true,
    "allowManualTimeInput": true,
    "allowCompletedTaskTime": true,
    "allowTimeWithoutEstimate": true,
    "allowManageEstimates": true,
    "lockTimeAfter": 2,
    "lockTimePeriod": "days"
  },
  "timezone": 3,
  "hasPassword": true,
  "dateFormat": 1,
  "dateTimeFormat": 12,
  "timeFormat": 1,
  "exportTimeFormat": 4,
  "exportCsvSeparator": 1,
  "timeRounding": 1,
  "timeRoundingDirection": "nearest",
  "startPage": "time",
  "activityMode": "detailed",
  "timeOffPermissions": {
    "read": "all",
    "write": "request"
  },
  "accounts": [
    {
      "id": "as:1185184465308295",
      "platform": "as",
      "name": "John Bender",
      "email": "john.bender@example.com",
      "status": "active",
      "createdAt": "2020-07-20 09:39:09"
    }
  ],
  "team": {
    "id": 2,
    "name": "Acme Inc",
    "createdAt": "2016-08-13 18:10:36",
    "logoUrl": "https://d36887svjhykt4.cloudfront.net/teams/2-16a7d93a236d9b.jpg",
    "owner": {
      "id": 7,
      "name": "Jane Doe",
      "headline": "CPO"
    },
    "workdays": [
      "MON",
      "TUE",
      "WED",
      "THU",
      "FRI"
    ],
    "beginningOfWeek": 1,
    "workHoursFrom": "09:00",
    "workHoursTo": "18:00",
    "workTimeMin": 23400,
    "workTimeMax": 30600,
    "lockTimeEnabled": true,
    "lockTimeAfter": 2,
    "lockTimePeriod": "days",
    "defaultRate": 5000,
    "defaultCost": 2500,
    "defaultCapacity": 144000,
    "currencyDetails": {
      "code": "USD",
      "name": "US Dollar",
      "symbol": "$"
    },
    "billing": {
      "plan": "team_monthly",
      "status": "paid",
      "seats": 18,
      "quantity": 18,
      "paidPeriodEnd": "2026-10-07 10:00:53",
      "trialEndedAt": "2018-08-03 10:26:27",
      "billingEmail": "billing@example.com",
      "canManageSeats": true
    },
    "timeOffPermissions": {
      "read": "all",
      "write": "request"
    }
  },
  "rate": 5000
}

Changes

Sep 18, 202692850a5e60d1 Revision changes
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status

Operation history

Get Current User

Request

Response 200OK

Example response

Changes

Response