user

Represents a Syngency user (administrator, agent, contact, model, or assistant).

ACCESS

Directly accessible in all Documents templates.

Example

{
  "id": 123,
  "token": null,
  "agency_id": 1,
  "user_type_id": 1,
  "office_id": null,
  "contact_id": null,
  "contact_department_type_id": null,
  "model_id": null,
  "two_factor_auth": null,
  "first_name": "John",
  "last_name": "Davis",
  "email": "jane@agency.com",
  "title": null,
  "phone": null,
  "mobile": null,
  "password": null,
  "signature": null,
  "email_signature": null,
  "email_notifications": null,
  "dashboard_widgets": null,
  "permissions": null,
  "notes": null,
  "commission_percentage": null,
  "is_active": 0,
  "is_superuser": 0,
  "created_at": "2025-01-31 12:00:00",
  "updated_at": "2025-01-31 12:00:00",
  "deleted_at": "2025-01-31 12:00:00",
  "name": "John Davis",
  "user_type_name": "Agent",
  "agency_name": null,
  "agency_timezone": null,
  "office_name": null,
  "last_login_at": "2025-01-31 12:00:00",
  "image": null,
  "logins": [],
  "unread_messages": 1,
  "outstanding_tasks": 1,
  "agent": null,
  "model_url": null,
  "unread_count": 1
}

Properties

id integer

token string

agency_id integer

user_type_id integer

1=Administrator, 2=Agent, 3=Contact, 4=Model, 5=Assistant

office_id integer

contact_id integer

contact_department_type_id integer

model_id integer

two_factor_auth string

first_name string

last_name string

email string

title string

phone string

mobile string

password string

signature string

email_signature string

email_notifications object

JSON-decoded array of notification settings

dashboard_widgets object

JSON-decoded array of dashboard widgets

permissions object

JSON-decoded array of permissions

notes string

commission_percentage number

Format: decimal

is_active boolean

is_superuser boolean

created_at datetime

updated_at datetime

deleted_at datetime

name string

Computed: first_name + last_name

user_type_name string

agency_name string

agency_timezone string

office_name string

last_login_at datetime

image string

Format: absolute-url

URL to user profile image

logins array

Recent login records (for agents)

unread_messages integer

Count of unread messages (for agents)

outstanding_tasks integer

Count of outstanding tasks (for agents)

agent object

Agent info (for models)

model_url string

Format: absolute-url

Portfolio URL (for models)

unread_count integer

Unread count (for models)