Skip to main content

UserProfileResponse

User profile response schema.

idId (string)required
emailEmail (string)required
nameName (string)required
roleRole (string)required
is_staffIs Staff (boolean)
Default value: false
is_superuserIs Superuser (boolean)
Default value: false
email_verifiedEmail Verified (boolean)required
created_atstring<date-time>required
updated_atstring<date-time>required
bio object
anyOf
string
avatar_url object
anyOf
string
phone_number object
anyOf
string
timezoneTimezone (string)
Default value: UTC
date_formatDate Format (string)
Default value: YYYY-MM-DD
time_formatTime Format (string)
Default value: 24h
email_notificationsEmail Notifications (boolean)
Default value: true
webhook_failure_notificationsWebhook Failure Notifications (boolean)
Default value: true
workflow_failure_notificationsWorkflow Failure Notifications (boolean)
Default value: true
usage_alert_notificationsUsage Alert Notifications (boolean)
Default value: true
marketing_emailsMarketing Emails (boolean)
Default value: false
default_map_styleDefault Map Style (string)
Default value: streets
default_geofence_colorDefault Geofence Color (string)
Default value: #3B82F6
show_tutorial_tooltipsShow Tutorial Tooltips (boolean)
Default value: true
default_api_versionDefault Api Version (string)
Default value: v1
selected_planSelected Plan (string)
Default value: free
company object
anyOf
string
UserProfileResponse
{
"id": "string",
"email": "string",
"name": "string",
"role": "string",
"is_staff": false,
"is_superuser": false,
"email_verified": true,
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"bio": "string",
"avatar_url": "string",
"phone_number": "string",
"timezone": "UTC",
"date_format": "YYYY-MM-DD",
"time_format": "24h",
"email_notifications": true,
"webhook_failure_notifications": true,
"workflow_failure_notifications": true,
"usage_alert_notifications": true,
"marketing_emails": false,
"default_map_style": "streets",
"default_geofence_color": "#3B82F6",
"show_tutorial_tooltips": true,
"default_api_version": "v1",
"selected_plan": "free",
"company": "string"
}