Users
The
User
object is used to represent a user in the remote system.Properties
name
StringOptional
The user's full name.
username
StringOptional
The user's username.
email
StringOptional
The user's email.
role
EnumOptional
The user's role. Possible values include:
ADMIN
, MANAGER
, CONTRIBUTOR
, VIEWER
. In cases where there is no clear mapping, the original value passed through will be returned.timezone
StringOptional
The user's timezone.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/users
https://api.merge.dev/api/mktg/v1/users
US
EU
Returns a list of User
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fields
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringusername
String
getResponse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtimezone
String
Hubspot Marketing Hub
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Keap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtimezone
String
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrole
Enumtimezone
Stringusername
String
Podium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_id
Stringrole
Enum
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Customer.io
GET
/users/{id}
https://api.merge.dev/api/mktg/v1/users/{id}
US
EU
Returns a User
object with the given id
.
Query & Path Parameters
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringusername
String
getResponse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtimezone
String
Hubspot Marketing Hub
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Keap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtimezone
String
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrole
Enumtimezone
Stringusername
String
Podium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_id
Stringrole
Enum
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
email
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Customer.io