User

The model that represents a user within GeckoForm


User fields

Field Type Fillable Reference
account_id   Reference Account
allowed_capture_devices   Integer
allowed_scan_devices   Integer
authorised_capture_devices   Integer
The current number of authorised GeckoForm Offline Capture devices
authorised_scan_devices   Integer
The current number of authorised GeckoScan devices
call_method   String Yes
The preferred call method for GeckoCall (e.g. VOIP)
call_sender_id   Integer Yes
can_start_call   Unknown
color   Color Yes
A color used to show against responses assigned, or captured by the user
config   Array
created_at   Timestamp
The date the user was created.
deactivated   Unknown
debug_mode   Unknown
deleted_at   Timestamp
The date the user was deleted.
email   Email Required
Email address of user
full_name   String Required
Full name of user
group_id   Reference Required Group
id   Integer
The unique ID to identify the user
invited   Unknown
is_away   Unknown
last_active   String
last_active_at   Timestamp
over_capture_device_limit   Boolean
Whether the current number of authorised GeckoForm devices exceeds the allowed concurrent devices
over_scan_device_limit   Boolean
Whether the current number of authorised GeckoScan devices exceeds the allowed concurrent devices
position   String Yes
The position of the user within their company
presence   Integer Yes
queue_statuses   Unknown
receive_digest   Unknown Yes
record_calls   Unknown Yes
safe_email   String
status   Integer
status_title   String
system_status   Integer
telephone   String Yes
The users telephone number
updated_at   Timestamp
The date the user was last updated.

User relations

account, active_call, active_call.contact, active_call.number, active_call.number.contacts, active_call.subscriber, active_call.outcome, active_call.user, active_call.sender, active_call.sender.inbound_campaigns, active_call.campaign, assigned, forms, group, inbound_senders, queue_statuses,

User endpoints

GET List all Users /users toggle

GET Return data for a specified User /users/:id toggle

POST Save, or update a User /users/:id? toggle

POST Resend an invitiation /users/:id toggle

POST Send the user a password reset email /users toggle

DELETE Delete a User /users/:id toggle