Users
The User object is used to represent a user with a login to the ticketing system.
Users are either assignees who are directly responsible or a viewer on a Ticket/ Collection.
Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringThe user's name.
email_addressStringThe user's email address.
is_activeBooleanWhether or not the user is active.
teamsArrayrolesArrayavatarStringThe user's avatar picture.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/users
https://api.merge.dev/api/ticketing/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.
email_addressStringOptional
If provided, will only return users with emails equal to this value (case insensitive).
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
teamStringOptional
If provided, will only return users matching in this team.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Asana
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Azure DevOps
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Basecamp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArray
Bitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArray
ClickUp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Dixa
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Freshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Freshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Front
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
GitHub Issues
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
GitLab
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Gladly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArray
Gorgias
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArray
Help Scout
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Hive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Intercom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_idStringrolesArrayteamsArray
Ironclad
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArray
Jira
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Jira Data Center
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArray
Jira Service Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Kustomer
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArray
Linear
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Pivotal Tracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Rally
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Re:amaze
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_idString
Salesforce Service Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
ServiceNow
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Shortcut
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_idStringteamsArray
SpotDraft
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Teamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Trello
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Wrike
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Zendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray
Zoho BugTracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Zoho Desk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayGET
/users/{id}
https://api.merge.dev/api/ticketing/v1/users/{id}
US
EU
APAC
Returns a User object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
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).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayAsana
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayAzure DevOps
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayBasecamp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayBitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayClickUp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayDixa
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringFreshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayFreshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayFront
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayGitHub Issues
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayGitLab
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayGladly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArrayGorgias
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArrayHelp Scout
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayHive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayIntercom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_idStringrolesArrayteamsArrayIronclad
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArrayJira
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayJira Data Center
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArrayJira Service Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayKustomer
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringteamsArrayLinear
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayPivotal Tracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringRally
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringRe:amaze
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_idStringSalesforce Service Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayServiceNow
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayShortcut
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_idStringteamsArraySpotDraft
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringTeamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayTrello
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayWrike
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayZendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringemail_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArrayZoho BugTracker
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringZoho Desk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringis_activeBooleannameStringremote_dataRemoteData[]pathstringdatastringremote_idStringrolesArrayteamsArray