Users

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

The User object

Properties


nameString
Optional
The user's name.

emailString
Optional
The user's email address.

is_activeBoolean
Optional
Whether or not the user is active.

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

field_mappingsObject
Optional

remote_fieldsRemoteField[]
Required

The User object
JSON
{
"name": "Gil Feig",
"email": "[email protected]",
"is_active": true,
"remote_data": [
{
"path": "/users",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"remote_id": "19202938",
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
},
"remote_fields": [
{
"value": {}
}
]
}

GET

/users

Returns a list of User objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"name": "Gil Feig",
"email": "[email protected]",
"is_active": true,
"remote_data": [
{
"path": "/users",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"remote_id": "19202938",
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
},
"remote_fields": [
{
"value": {}
}
]
}
]
}
Field support by platform

Accelo

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Insightly

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Microsoft Dynamics 365 Sales

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Nutshell

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Pipeliner

Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SugarCRM

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Vtiger

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/users/{id}

Returns a User object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
Required

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

include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
Response
JSON
{
"name": "Gil Feig",
"email": "[email protected]",
"is_active": true,
"remote_data": [
{
"path": "/users",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
"remote_id": "19202938",
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
},
"remote_fields": [
{
"value": {}
}
]
}
Field support by platform

Accelo

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Insightly

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Microsoft Dynamics 365 Sales

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Nutshell

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Pipeliner

Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SugarCRM

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Vtiger

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/users/remote-field-classes

CLOSED BETA

Returns a list of RemoteFieldClass objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

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

page_sizeInteger
Optional
Number of results to return per page.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"display_name": "string",
"remote_key_name": "string",
"description": "string",
"is_required": true,
"field_choices": [
"string"
],
"item_schema": {
"item_type": "string",
"item_format": "string",
"item_choices": [
"string"
]
},
"is_custom": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
Field support by platform

Accelo

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Insightly

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Microsoft Dynamics 365 Sales

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Nutshell

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Pipeliner

Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SugarCRM

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Vtiger

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


emailString

is_activeBoolean

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.