Users
The RemoteUser object is used to represent a user with a login to the ATS system.
The RemoteUser object
Properties
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
first_nameString
Optional
The user's first name.
last_nameString
Optional
The user's last name.
emailString
Optional
The user's email.
disabledBoolean
Optional
Whether the user's account had been disabled.
remote_created_atString
Optional
When the third party's user was created.
access_roleEnum
Optional
The user's role. Possible values include: SUPER_ADMIN, ADMIN, TEAM_MEMBER, LIMITED_TEAM_MEMBER, INTERVIEWER, or - in cases where there is no clear mapping - the original value passed through.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
modified_atString
Required
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]
Optional
The RemoteUser object
JSON
{
  "id": "b82302de-852e-4e60-b050-edf9da3b7c02",
  "remote_id": "344321",
  "first_name": "Shensi",
  "last_name": "Ding",
  "email": "[email protected]",
  "disabled": true,
  "remote_created_at": "2020-11-10T00:00:00Z",
  "access_role": "SUPER_ADMIN",
  "remote_was_deleted": true,
Show advanced fields
}
GET
/users

Returns a list of RemoteUser 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.
emailString
Optional
If provided, will only return remote users with the given email address
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, only objects synced by Merge after this date time will be returned.
modified_beforeString
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_fieldsString
Optional
Deprecated. Use show_enum_origins.
remote_idString
Optional
The API provider's ID for the given object.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "b82302de-852e-4e60-b050-edf9da3b7c02",
      "remote_id": "344321",
      "first_name": "Shensi",
      "last_name": "Ding",
      "email": "[email protected]",
      "disabled": true,
      "remote_created_at": "2020-11-10T00:00:00Z",
      "access_role": "SUPER_ADMIN",
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}
Field support by platform
ApplicantStack
ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
Ashby
Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
BizMerlinHR
BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_idString
Breezy
Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
CATS
CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Clockwork
Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Cornerstone TalentLink
Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Fountain
Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Freshteam
Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Greenhouse
Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
HR Cloud
HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
iCIMS
iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
JazzHR
JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
JobAdder
JobAdder

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
JobScore
JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jobvite
Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Lever
Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Oracle Taleo
Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Recruitee
Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Recruiterflow
Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
SAP SuccessFactors
SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
SmartRecruiters
SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
TalentLyft
TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
TalentReef
TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Teamtailor
Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Workable
Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
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 RemoteUser 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.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "id": "b82302de-852e-4e60-b050-edf9da3b7c02",
  "remote_id": "344321",
  "first_name": "Shensi",
  "last_name": "Ding",
  "email": "[email protected]",
  "disabled": true,
  "remote_created_at": "2020-11-10T00:00:00Z",
  "access_role": "SUPER_ADMIN",
  "remote_was_deleted": true,
Show advanced fields
}
Field support by platform
ApplicantStack
ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
Ashby
Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
BizMerlinHR
BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_idString
Breezy
Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
CATS
CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Clockwork
Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Cornerstone TalentLink
Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Fountain
Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Freshteam
Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Greenhouse
Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
HR Cloud
HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
iCIMS
iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
JazzHR
JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
JobAdder
JobAdder

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
JobScore
JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Jobvite
Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Lever
Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Oracle Taleo
Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_created_atString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Recruitee
Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Recruiterflow
Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

disabledBoolean
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
SAP SuccessFactors
SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
SmartRecruiters
SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
disabledBoolean
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
TalentLyft
TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
TalentReef
TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Teamtailor
Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Workable
Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

access_roleEnum
emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString
first_nameString
last_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
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
Tags
Next Up
Account Details