Sign in

v1

latestOpenAPI 3.1.1LicenseRef-Proprietary2026-07-1310179223.1 KB
Users

Get Current User

Retrieve the user that owns the API key, including personal settings (timezone, formats, API key).

get/users/me

Response

OK

idnumber required
namestring required
headlinestring nullable
avatarUrlstring nullable
role'admin' | 'supervisor' | 'member' | 'member_limited' required
status'active' | 'invited' | 'pending' | 'removed' required
phonestring nullable
capacityinteger nullable

Weekly capacity in seconds.

avatarUrlLargestring nullable
timezonenumber

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

apiKeystring
type'employee' | 'contractor'
createdAtstring

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

dateFormatinteger
timeFormatinteger
timeRoundinginteger
countrystring

ISO 3166-1 alpha-2 country code.

teamobject

The user's team.

rateinteger

Hourly bill rate in cents (admins only).

costinteger

Hourly cost in cents (requires cost permissions).

Example response

{
  "id": 1304,
  "name": "User Name",
  "headline": "CEO",
  "role": "admin",
  "status": "active"
}