Merge Marketing Automation

Users

The User object is used to represent a user in the remote system.

The User object

Properties

nameString

Optional

The user's full name.

usernameString

Optional

The user's username.

emailString

Optional

The user's email.

roleEnum

Optional

The user's role. Possible values include: ADMIN, MANAGER, CONTRIBUTOR, VIEWER, or - in cases where there is no clear mapping - the original value passed through.

timezoneString

Optional

The user's timezone.

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

modified_atString

Required

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

remote_dataRemoteData[]

Optional

The User object

JSON


{
  "name": "Gil Feig",
  "username": "gilfeig",
  "email": "[email protected]",
  "role": "ADMIN",
  "timezone": "New York/EST",
  "remote_was_deleted": true,
  "id": "3756cbc6-6040-430a-475r-aafacbadf4sd",
  "remote_id": "1",
Show advanced fields
}

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.

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",
      "username": "gilfeig",
      "email": "[email protected]",
      "role": "ADMIN",
      "timezone": "New York/EST",
      "remote_was_deleted": true,
      "id": "3756cbc6-6040-430a-475r-aafacbadf4sd",
      "remote_id": "1",
Show advanced fields
    }
  ]
}

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

usernameString

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

timezoneString

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

timezoneString

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

roleEnum

timezoneString

usernameString

Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_idString

roleEnum

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Customer.io

Coming Soon

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.

Response

JSON


{
  "name": "Gil Feig",
  "username": "gilfeig",
  "email": "[email protected]",
  "role": "ADMIN",
  "timezone": "New York/EST",
  "remote_was_deleted": true,
  "id": "3756cbc6-6040-430a-475r-aafacbadf4sd",
  "remote_id": "1",
Show advanced fields
}