object AuthenticatedUser

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

emailString

Email address for the contact.

first_nameString

First name for the address or contact.

last_nameString

Last name for the address or contact.

created_atISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

updated_atISODateTime

Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

is_adminBoolean

Whether this user is admin.

profile_imageString

Profile image for this user.

default_picking_optionString

Default picking option for this user.

positionString

Position for this user.

hourly_rateDecimal

Monetary amount as a decimal value in the record currency; not cents.

payroll_idString

Public API payroll ID that identifies the related record.

default_order_statusString

Current default order status; use the API status values returned by this field when filtering or updating.

default_warehouse_idString

Public API default warehouse ID that identifies the related record.

is_activeBoolean

Whether this user is active.

is_developerBoolean

Whether this user is developer.

default_pick_order_tagString

Default pick order tag for this user.

accountAccount

Account for this user.

allowed_warehouses[Warehouse]

List of allowed warehouses for this user.

stores[Store]

List of stores for this user.

scopes[String]

Scopes granted by the authenticated backend.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "email": "customer@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "created_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z",
  "is_admin": true,
  "profile_image": "default",
  "default_picking_option": "batch",
  "position": "picker",
  "hourly_rate": 19.99,
  "payroll_id": "UGF5cm9sbDoxMjM0",
  "default_order_status": "pending",
  "default_warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "is_active": true,
  "is_developer": true,
  "default_pick_order_tag": "priority",
  "account": {id: "QWNjb3VudDoxMjM0"},
  "allowed_warehouses": [[{id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"}]],
  "stores": [[{id: "U3RvcmU6MTIzNA=="}]],
  "scopes": ["view:orders", "change:inventory"]
}