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.
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
The User object
JSON
{
  "name": "Gil Feig",
  "username": "gilfeig",
  "email": "[email protected]",
  "role": "ADMIN",
  "timezone": "New York/EST",
  "id": "3756cbc6-6040-430a-475r-aafacbadf4sd",
  "remote_id": "1"
}
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, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
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",
      "id": "3756cbc6-6040-430a-475r-aafacbadf4sd",
      "remote_id": "1"
    }
  ]
}
Field support by platform

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
usernameString

getResponse

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
timezoneString

Hubspot Marketing Hub

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
timezoneString

Mailchimp

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
roleEnum
timezoneString
usernameString

Podium

Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
roleEnum

Sendinblue

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
Customer.io

Customer.io

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
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",
  "id": "3756cbc6-6040-430a-475r-aafacbadf4sd",
  "remote_id": "1"
}
Field support by platform

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
usernameString

getResponse

getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
timezoneString

Hubspot Marketing Hub

Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
timezoneString

Mailchimp

Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
roleEnum
timezoneString
usernameString

Podium

Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
roleEnum

Sendinblue

Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
nameString
remote_idString
Customer.io

Customer.io

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Templates

Next Up

Account Details