For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The RemoteUser object
          • GET/users
          • GET/users/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsUsers

The RemoteUser object

The RemoteUser Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "first_name": "string",
7  "last_name": "string",
8  "email": "string",
9  "disabled": true,
10  "remote_created_at": "2023-01-01T00:00:00Z",
11  "access_role": "SUPER_ADMIN",
12  "remote_was_deleted": true,
13  "field_mappings": {},
14  "remote_data": [
15    {
16      "path": "string",
17      "data": {}
18    }
19  ]
20}
Was this page helpful?
Previous

/tags

Next

/users

Built with

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.

  • SUPER_ADMIN - SUPER_ADMIN
  • ADMIN - ADMIN
  • TEAM_MEMBER - TEAM_MEMBER
  • LIMITED_TEAM_MEMBER - LIMITED_TEAM_MEMBER
  • INTERVIEWER - INTERVIEWER
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