Skip to navigation

The RemoteUser object

The RemoteUser object is used to represent a user with a login to the ATS system.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
first_namestring or nullOptional
The user's first name.
last_namestring or nullOptional
The user's last name.
emailstring or nullOptionalformat: "email"<=254 characters
The user's email.
disabledboolean or nullOptional
Whether the user's account had been disabled.
remote_created_atdatetime or nullOptional
When the third party's user was created.
access_roleenum or nullOptional

The user's role. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=access_role to receive the integration's own value instead.

Allowed values:
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only