Users
TheRemoteUser
object is used to represent a user with a login to the ATS system.The RemoteUser object
Properties
id
Stringremote_id
Stringfirst_name
Stringlast_name
Stringemail
Stringdisabled
Booleanremote_created_at
Stringaccess_role
EnumSUPER_ADMIN
, ADMIN
, TEAM_MEMBER
, LIMITED_TEAM_MEMBER
, INTERVIEWER
, or - in cases where there is no clear mapping - the original value passed through.remote_data
RemoteData[]remote_was_deleted
Booleanfield_mappings
Object{"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_data": [{"path": "/users","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
/users
Returns a list of RemoteUser
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringemail
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
String{"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_data": [{"path": "/users","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}

ApplicantStack
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
first_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
object
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
BizMerlinHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_id
String
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
CATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Clockwork
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Freshteam
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
iCIMS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JobAdder
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Jobvite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Recruiterflow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
TalentLyft
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
TalentReef
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String/users/{id}
Returns a RemoteUser
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
id
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"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_data": [{"path": "/users","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}

ApplicantStack
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
first_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
object
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
BizMerlinHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_id
String
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
CATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Clockwork
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Freshteam
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
iCIMS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JobAdder
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Jobvite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Recruiterflow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
disabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumdisabled
Booleanemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
TalentLyft
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
TalentReef
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
access_role
Enumemail
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String