/users/{id}

Returns a User object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-only

The datetime that this object was modified by Merge.

namestring or null

The user's name.

emailstring or null

The user's email address.

is_activeboolean or null

Whether or not the user is active.

remote_was_deletedboolean or nullRead-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 nullRead-only

remote_datalist of objects or nullRead-only

remote_fieldslist of objects or nullRead-only

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	client.crm.users.retrieve(
8	id="id",
9	)

1	{
2	"id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
3	"remote_id": "19202938",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"name": "Gil Feig",
7	"email": "merge_is_hiring@merge.dev",
8	"is_active": true,
9	"remote_was_deleted": true,
10	"field_mappings": {
11	"organization_defined_targets": {
12	"custom_key": "custom_value"
13	},
14	"linked_account_defined_targets": {
15	"custom_key": "custom_value"
16	}
17	},
18	"remote_data": [
19	{
20	"path": "/users"
21	}
22	],
23	"remote_fields": [
24	{
25	"remote_field_class": {
26	"id": "string",
27	"display_name": "string",
28	"remote_key_name": "string",
29	"description": "string",
30	"is_custom": true,
31	"is_common_model_field": true,
32	"is_required": true,
33	"field_type": "string",
34	"field_format": "string",
35	"field_choices": [
36	"string"
37	],
38	"item_schema": {
39	"item_type": "string",
40	"item_format": "string",
41	"item_choices": [
42	"string"
43	]
44	}
45	},
46	"value": "string"
47	}
48	]
49	}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration