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

/tasks/remote-field-classes

Next

/users

Built with

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.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only