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 User object
          • GET/users
          • GET/users/{id}
          • POST/users/ignore/{model_id}
          • GET/users/remote-field-classes

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsUsers

The User object

The User 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  "name": "string",
7  "email": "string",
8  "is_active": true,
9  "user_url": "string",
10  "remote_was_deleted": true,
11  "field_mappings": {
12    "organization_defined_targets": {
13      "string": {}
14    },
15    "linked_account_defined_targets": {
16      "string": {}
17    }
18  },
19  "remote_data": [
20    {
21      "path": "string",
22      "data": {}
23    }
24  ],
25  "remote_fields": [
26    {
27      "remote_field_class": {
28        "id": "string",
29        "display_name": "string",
30        "remote_key_name": "string",
31        "description": "string",
32        "is_custom": true,
33        "is_common_model_field": true,
34        "is_required": true,
35        "field_type": "string",
36        "field_format": "string",
37        "field_choices": [
38          "string"
39        ],
40        "item_schema": {
41          "item_type": "string",
42          "item_format": "string",
43          "item_choices": [
44            "string"
45          ]
46        }
47      },
48      "value": {
49        "string": {}
50      }
51    }
52  ]
53}
Was this page helpful?
Previous

/tasks/remote-field-classes

Next

/users

The User object is used to represent a user with a login to the CRM system.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The user's name.
emailstring or nullOptional
The user's email address.
is_activeboolean or nullOptional
Whether or not the user is active.
user_urlstring or nullOptionalformat: "uri"<=2000 characters
The user's URL in the remote system.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only