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

idUUID
Required

remote_idString
Optional
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.

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. In cases where there is no clear mapping, the original value passed through will be returned.

timezoneString
Optional
The user's timezone.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/users

https://api.merge.dev/api/mktg/v1/users

US
EU

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.

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_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_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Keap
Keap
Mailchimp
Mailchimp
Podium
Podium
Sendinblue
Sendinblue
Customer.io
Customer.io
Coming soon
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

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Keap
Keap
Mailchimp
Mailchimp
Podium
Podium
Sendinblue
Sendinblue
Customer.io
Customer.io
Coming soon