Users
The RemoteUser object is used to represent a user with a login to the ATS system.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

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

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/ats/v1/users

US
EU

Returns a list of RemoteUser 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.

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_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_fieldsString
Optional
Deprecated. Use show_enum_origins.

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

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Ashby
Ashby
BambooHR
BambooHR
Breezy
Breezy
Bullhorn
Bullhorn
CATS
CATS
ClayHR
ClayHR
Clockwork
Clockwork
Cornerstone TalentLink
Cornerstone TalentLink
Fountain
Fountain
Freshteam
Freshteam
Greenhouse
Greenhouse
HR Cloud
HR Cloud
iCIMS
iCIMS
JazzHR
JazzHR
JobAdder
JobAdder
JobScore
JobScore
Jobvite
Jobvite
Lever
Lever
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
Recruiterflow
Recruiterflow
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
TalentLyft
TalentLyft
TalentReef
TalentReef
Teamtailor
Teamtailor
Tellent
Tellent
Workable
Workable
Workday
Workday
Zoho Recruit
Zoho Recruit
GET
/users/{id}

https://api.merge.dev/api/ats/v1/users/{id}

US
EU

Returns a RemoteUser 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.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Ashby
Ashby
BambooHR
BambooHR
Breezy
Breezy
Bullhorn
Bullhorn
CATS
CATS
ClayHR
ClayHR
Clockwork
Clockwork
Cornerstone TalentLink
Cornerstone TalentLink
Fountain
Fountain
Freshteam
Freshteam
Greenhouse
Greenhouse
HR Cloud
HR Cloud
iCIMS
iCIMS
JazzHR
JazzHR
JobAdder
JobAdder
JobScore
JobScore
Jobvite
Jobvite
Lever
Lever
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
Recruiterflow
Recruiterflow
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
TalentLyft
TalentLyft
TalentReef
TalentReef
Teamtailor
Teamtailor
Tellent
Tellent
Workable
Workable
Workday
Workday
Zoho Recruit
Zoho Recruit