Users
The
User object is used to represent a user in the remote system.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The user's full name.
usernameStringOptional
The user's username.
emailStringOptional
The user's email.
roleEnumOptional
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.timezoneStringOptional
The user's timezone.
remote_was_deletedBooleanRequired
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.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/users
https://api.merge.dev/api/mktg/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.
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_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.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
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_idStringusernameString
getResponse
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_idStringtimezoneString
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
emailStringnameStringremote_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
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtimezoneString
Mailchimp
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_idStringroleEnumtimezoneStringusernameString
Podium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_idStringroleEnum
Sendinblue
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
Customer.io
GET
/users/{id}
https://api.merge.dev/api/mktg/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.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
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_idStringusernameStringgetResponse
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_idStringtimezoneStringHubspot 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
emailStringnameStringremote_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
emailStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtimezoneStringMailchimp
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_idStringroleEnumtimezoneStringusernameStringPodium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
emailStringnameStringremote_idStringroleEnumSendinblue
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_idStringCustomer.io