Merge CRM - Users

Users

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

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_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.

created_atString

Required

modified_atString

Required

This is the datetime that this object was last updated by Merge

field_mappingsObject

Optional

remote_dataRemoteData[]

Optional

remote_fieldsRemoteField[]

Required

The User object

JSON


{
  "name": "Gil Feig",
  "email": "[email protected]",
  "is_active": true,
  "remote_was_deleted": true,
  "id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "remote_id": "19202938",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}

GET

/users

https://api.merge.dev/api/crm/v1/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, only objects synced by Merge after this date time will be returned.

modified_beforeString

Optional

If provided, only objects synced by Merge before this date time will be returned.

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_was_deleted": true,
      "id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
      "remote_id": "19202938",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_fieldsRemoteField[]

remote_field_classobject

valueobject

remote_idString

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_fieldsRemoteField[]

remote_field_classobject

valueobject

remote_idString

Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_fieldsRemoteField[]

remote_field_classobject

valueobject

remote_idString

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

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

GET

/users/{id}

https://api.merge.dev/api/crm/v1/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_was_deleted": true,
  "id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "remote_id": "19202938",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_fieldsRemoteField[]

remote_field_classobject

valueobject

remote_idString

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_fieldsRemoteField[]

remote_field_classobject

valueobject

remote_idString

Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_fieldsRemoteField[]

remote_field_classobject

valueobject

remote_idString

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_dataRemoteData[]

pathstring

datastring

remote_idString

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

POST

/users/ignore/{model_id}

https://api.merge.dev/api/crm/v1/users/ignore/{model_id}

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.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

model_idString

Required

Body Parameters

reasonEnum

Required

Must pass in one of the following choices: GENERAL_CUSTOMER_REQUEST, GDPR, OTHER.

messageString

Required

POST v1/users/ignore/{model_id}

JSON


{
  "reason": "GENERAL_CUSTOMER_REQUEST",
  "message": "deletion request by user id 51903790-7dfe-4053-8d63-5a10cc4ffd39"
}

Response

JSON


No content

GET

/users/remote-field-classes

Closed Beta

https://api.merge.dev/api/crm/v1/users/remote-field-classes

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": [
    {
      "id": "string",
      "display_name": "string",
      "remote_key_name": "string",
      "description": "string",
      "is_custom": true,
      "is_required": true,
      "field_type": "string",
      "field_format": "string",
      "field_choices": [
        "string"
      ],
      "item_schema": {
        "item_type": "string",
        "item_format": "string",
        "item_choices": [
          "string"
        ]
      }
    }
  ]
}