Skip to main content
GET
Get Current User

Authorizations

X-Api-Key
string
header
required

Response

OK

Additional fields returned only for the authenticated user.

id
number
required
Example:

1304

name
string
required
Example:

"User Name"

role
enum<string>
required
Available options:
admin,
supervisor,
member,
member_limited
Example:

"admin"

status
enum<string>
required
Available options:
active,
invited,
pending,
removed
Example:

"active"

headline
string | null
Example:

"CEO"

avatarUrl
string | null
phone
string | null
capacity
integer | null

Weekly capacity in seconds.

avatarUrlLarge
string | null
timezone
number

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

apiKey
string
type
enum<string>
Available options:
employee,
contractor
createdAt
string

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

dateFormat
integer
timeFormat
integer
timeRounding
integer
country
string

ISO 3166-1 alpha-2 country code.

team
object

The user's team.

rate
integer

Hourly bill rate in cents (admins only).

cost
integer

Hourly cost in cents (requires cost permissions).