Users

The RemoteUser object is used to represent a third party user.

The RemoteUser object

Properties


idString
Optional

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_dataRemoteData[]
Optional

The RemoteUser object

{
  "id": "b82302de-852e-4e60-b050-edf9da3b7c02",
  "remote_id": "344321",
  "first_name": "Shensi",
  "last_name": "Ding",
  "email": "hello@merge.dev",
  "disabled": true,
  "remote_created_at": "2020-11-10T00:00:00Z",
  "access_role": "SUPER_ADMIN",
  "remote_data": [
    {
      "path": "/users",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/users

Returns a list of RemoteUser objects.


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_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

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "b82302de-852e-4e60-b050-edf9da3b7c02",
      "remote_id": "344321",
      "first_name": "Shensi",
      "last_name": "Ding",
      "email": "hello@merge.dev",
      "disabled": true,
      "remote_created_at": "2020-11-10T00:00:00Z",
      "access_role": "SUPER_ADMIN",
      "remote_data": [
        {
          "path": "/users",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

last_nameString

emailString

first_nameString

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

first_nameString

last_nameString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

last_nameString

emailString

first_nameString

remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


first_nameString

last_nameString

emailString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

last_nameString

emailString

first_nameString

remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

last_nameString

disabledBoolean

emailString

first_nameString

remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

last_nameString

emailString

first_nameString

remote_idString
POST

/users

BETA

Creates a RemoteUser object with the given values.


Query & Path Parameters


remote_user_idString
Optional
The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


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. Must pass in one of the following choices: SUPER_ADMIN, ADMIN, TEAM_MEMBER, LIMITED_TEAM_MEMBER, INTERVIEWER.

Response

{
  "id": "b82302de-852e-4e60-b050-edf9da3b7c02",
  "remote_id": "344321",
  "first_name": "Shensi",
  "last_name": "Ding",
  "email": "hello@merge.dev",
  "disabled": true,
  "remote_created_at": "2020-11-10T00:00:00Z",
  "access_role": "SUPER_ADMIN",
  "remote_data": [
    {
      "path": "/users",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Required

Supported POST Body Parameters


remote_created_atString
Optional

access_roleEnum
Optional

last_nameString
Required

emailString
Required

first_nameString
Required

remote_idString
Optional

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Required

Supported POST Body Parameters


remote_created_atString
Optional

access_roleEnum
Optional

last_nameString
Required

emailString
Required

first_nameString
Required

remote_idString
Optional

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


access_roleEnum
Required

disabledBoolean
Optional

last_nameString
Required

emailString
Required

first_nameString
Required

remote_idString
Optional
GET

/users/{id}

Returns a RemoteUser object with the given id.


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

{
  "id": "b82302de-852e-4e60-b050-edf9da3b7c02",
  "remote_id": "344321",
  "first_name": "Shensi",
  "last_name": "Ding",
  "email": "hello@merge.dev",
  "disabled": true,
  "remote_created_at": "2020-11-10T00:00:00Z",
  "access_role": "SUPER_ADMIN",
  "remote_data": [
    {
      "path": "/users",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

last_nameString

emailString

first_nameString

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

disabledBoolean

last_nameString

emailString

first_nameString

remote_idString

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

first_nameString

last_nameString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

last_nameString

emailString

first_nameString

remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

access_roleEnum

last_nameString

emailString

first_nameString

remote_idString

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


first_nameString

last_nameString

emailString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

last_nameString

emailString

first_nameString

remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_created_atString

last_nameString

disabledBoolean

emailString

first_nameString

remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

last_nameString

emailString

first_nameString

remote_idString