Users
The
User object is used to represent a user with a login to the CRM system.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringThe user's name.
emailStringThe user's email address.
is_activeBooleanWhether or not the user is active.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
remote_fieldsRemoteField[]GET
/users
https://api.merge.dev/api/crm/v1/users
US
EU
APAC
Returns a list of User objects.
Query & path parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
emailStringOptional
If provided, will only return users with this email.
include_deleted_dataBooleanOptional
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.
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).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Accelo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Capsule
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Close
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Copper
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idString
Insightly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Keap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Microsoft Dynamics 365 Sales
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Nutshell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Pipedrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idString
Pipeliner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Salesflare
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idString
SugarCRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Teamleader
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Teamwork CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Vtiger
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Zendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Zoho CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGET
/users/{id}
https://api.merge.dev/api/crm/v1/users/{id}
US
EU
APAC
Returns a User object with the given id.
Query & path parameters
idUUIDRequired
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).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Accelo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringCapsule
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringClose
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringCopper
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringInsightly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringKeap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringMicrosoft Dynamics 365 Sales
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringNutshell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPipedrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringPipeliner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringSalesflare
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringSalesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringSugarCRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringTeamleader
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringTeamwork CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringVtiger
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringZendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringZoho CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPOST
/users/ignore/{model_id}
https://api.merge.dev/api/crm/v1/users/ignore/{model_id}
US
EU
APAC
Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
Query & path parameters
model_idUUIDRequired
Body parameters
reasonEnumRequired
Must pass in one of the following choices:
GENERAL_CUSTOMER_REQUEST, GDPR, OTHER.messageStringRequired
GET
/users/remote-field-classes
Betahttps://api.merge.dev/api/crm/v1/users/remote-field-classes
US
EU
APAC
Returns a list of RemoteFieldClass objects.
Query & path parameters
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
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.
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).
is_common_model_fieldBooleanOptional
If provided, will only return remote field classes with this is_common_model_field value
is_customBooleanOptional
If provided, will only return remote fields classes with this is_custom value
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.