Users

Get current user

Retrieve the profile of the currently authenticated user. Returns account details including name, email, time zone, subscription plan, and onboarding status.

GET /v1/users/me

Parameters

Query parameters

include
array<string>
Related records to include (e.g. mobile_settings, workflow_settings)
fresh
boolean
Skip the cache and fetch the latest data from the database

Responses

200 — Successful response

Content-Type: application/json

error
boolean required
data
object required
data.id
string
Unique user identifier (Firebase UID)
data.first_name
string | null
User's first name
data.last_name
string | null
User's last name
data.email
string (email)
User's email address
data.image_url
string | null
Profile image URL
data.time_zone
string
User's time zone (IANA format)
data.pricing_plan
string
Current subscription plan
data.onboarded_web
boolean
Whether the user has completed web onboarding
data.onboarded_mobile
boolean
Whether the user has completed mobile onboarding
data.created_at
string (date-time)
data.updated_at
string (date-time)
data.sync_schedule
object
Advisory client scheduling hint (seconds until the next background sync check). Internal; may change without notice.
data.sync_schedule.imessage
integer
data.sync_schedule.phone_calls
integer
data.sync_schedule.linkedin_connections
integer
data.sync_schedule.linkedin_messages
integer

Example

{
  "error": false,
  "data": {
    "id": "string",
    "first_name": "string"
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)
any

401 — Missing or invalid API key.

Content-Type: application/json

(body)
any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)
any

404 — Resource does not exist.

Content-Type: application/json

(body)
any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)
any

429 — Rate limit exceeded.

Content-Type: application/json

(body)
any

500 — Unexpected server error.

Content-Type: application/json

(body)
any

Code samples

curl https://api.prod.getdex.com/v1/users/me \
  --header 'Authorization: Bearer YOUR_API_KEY'
Copyright © 2026