Users

Model

# User Model

object "user"
The description of the model.

id string
Unique identifier for the user.

name string
The user's full name.

email string
The email for the user.

phone string
The user's phone number.

organization_id string
Unique identifier for the organization that owns this delivery. This will always be your organization ID.

profile_id string
The unique identifier for the user's profile.

onboarded_apps string[]
The ID's of the apps the user has access on the PackageX Dashboard.

created_at integer
Time in epoch seconds when this resource was created.

updated_at integer
Time in epoch seconds when this resource was last updated.

signed_in_at integer
The last time this user signed into the PackageX dashboard.

is_virtual_user boolean
Indicates if this user is a virtual user, based on their email prefix.

dob string
The user's date of birth. This is currently unused.

developer_mode boolean
The user wants additional logging shown. When signing into the PackageX Dashboard, we'll show resource IDs when they would typically not be shown.

dark_mode boolean
If this user has dark mode enabled, which can be synced across platforms.

show_dock boolean
Indicates if the user has the dock visible in the PackageX Dashboard.

locations string[]
An array of locations associated with the user.

notification_events string[]
The user's preferred notification events, converted to a dot notation format.

fcm_tokens string[]
The user's Firebase Cloud Messaging tokens for push notifications.

requirements object
An object containing any errors, pending verifications, or requirements for the user account.

role "user"|"admin"|"developer"|"owner"
The unique identifier for the user's role.

role_id "user"|"admin"|"developer"|"owner"
The unique identifier for the user's role.

scopes string[]
The scopes and permissions associated with the user's role.

updated_by string
The ID of the user or key who last updated the user.

metadata object
Additional metadata associated with the user's profile.

_search object
A special property that will be included if searching through users. This is a flat object that contains various properties related to the search results. Each property may include <mark> tags around characters that have matched the search query, allowing for easy highlighting in the user interface. The properties within this object provide relevant information about the search results, such as name, email, relevance score, and the original query used for the search.

checksum string
A hash value computed from the current user configuration. This value gets updated whenever the user updates.