Applications

The Application object is used to represent an Application for a job position. This is separate from the Candidate object, although some systems may only allow a Candidate to have one Application.

Please note: Application objects are constructed if the object does not exist in the remote system.

The Application object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

candidateString

Optional

jobString

Optional

applied_atString

Optional

When the application was submitted.

rejected_atString

Optional

When the application was rejected.

sourceString

Optional

The application's source.

credited_toString

Optional

current_stageString

Optional

reject_reasonString

Optional

custom_fieldsObject

Optional

Custom fields configured for a given model.

remote_was_deletedBoolean

Required

The Application object

JSON


{
  "id": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
  "remote_id": "98796",
  "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
  "job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
  "applied_at": "2021-10-15T00:00:00Z",
  "rejected_at": "2021-11-15T00:00:00Z",
  "source": "Campus recruiting event",
  "credited_to": "58166795-8d68-4b30-9bfb-bfd402479484",
  "current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea",
  "reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784",
  "custom_fields": {},
  "remote_was_deleted": true
}

GET

/applications

Returns a list of Application objects.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

candidate_idString

Optional

If provided, will only return applications for this candidate.

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.

credited_to_idString

Optional

If provided, will only return applications credited to this user.

current_stage_idString

Optional

If provided, will only return applications at this interview stage.

cursorString

Optional

The pagination cursor value.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

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.

job_idString

Optional

If provided, will only return applications for this job.

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.

reject_reason_idString

Optional

If provided, will only return applications with this reject reason.

remote_idString

Optional

The API provider's ID for the given object.

sourceString

Optional

If provided, will only return applications with this source.

Response

JSON


{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
      "remote_id": "98796",
      "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
      "job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
      "applied_at": "2021-10-15T00:00:00Z",
      "rejected_at": "2021-11-15T00:00:00Z",
      "source": "Campus recruiting event",
      "credited_to": "58166795-8d68-4b30-9bfb-bfd402479484",
      "current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea",
      "reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784",
      "custom_fields": {},
      "remote_was_deleted": true
    }
  ]
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

sourceString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

reject_reasonString

remote_idString

sourceString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

sourceString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

jobString

remote_idString

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

sourceString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

sourceString

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

jobString

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Jobscore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

sourceString

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

sourceString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

rejected_atString

sourceString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

remote_idString

sourceString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

sourceString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

credited_toString

current_stageString

jobString

rejected_atString

remote_idString

sourceString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

sourceString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

reject_reasonString

rejected_atString

sourceString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

remote_idString

sourceString

Hint: Use the /linked-accounts endpoint to pull platform support information.

POST

/applications

Creates an Application object with the given values.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

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

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

remote_user_idString

Required

Model Parameters

remote_idString

Optional

The third-party API ID of the matching object.

candidateString

Optional

Must pass in a valid Merge ID, which can be obtained from the id field in the Candidate table.

jobString

Optional

Must pass in a valid Merge ID, which can be obtained from the id field in the Job table.

applied_atString

Optional

When the application was submitted.

rejected_atString

Optional

When the application was rejected.

sourceString

Optional

The application's source.

credited_toString

Optional

Must pass in a valid Merge ID, which can be obtained from the id field in the Credited_to table.

current_stageString

Optional

Must pass in a valid Merge ID, which can be obtained from the id field in the Current_stage table.

reject_reasonString

Optional

Must pass in a valid Merge ID, which can be obtained from the id field in the Reject_reason table.

custom_fieldsObject

Optional

Custom fields configured for a given model.

remote_template_idString

Optional

integration_paramsObject

Optional

linked_account_paramsObject

Optional

Response

JSON


{
  "model": {
    "id": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
    "remote_id": "98796",
    "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
    "job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
    "applied_at": "2021-10-15T00:00:00Z",
    "rejected_at": "2021-11-15T00:00:00Z",
    "source": "Campus recruiting event",
    "credited_to": "58166795-8d68-4b30-9bfb-bfd402479484",
    "current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea",
    "reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784",
    "custom_fields": {},
    "remote_was_deleted": true
  },
  "warnings": [
    {
      "source": {
        "pointer": "/age"
      },
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD"
    }
  ],
  "errors": [
    {
      "source": {
        "pointer": "/model/custom_fields"
      },
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD"
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "https://harvest.greenhouse.io/v1/candidates/",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Ashby

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

applied_atString

Optional

candidateString

Required

current_stageString

Optional

jobString

Required

remote_idString

Optional

sourceString

Optional

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

applied_atString

Optional

candidateString

Optional

jobString

Optional

remote_idString

Optional

sourceString

Optional

Eploy

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

candidateString

Required

jobString

Required

remote_idString

Optional

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Required

Supported POST Body Parameters

applied_atString

Optional

candidateString

Required

credited_toString

Optional

current_stageString

Optional

jobString

Required

rejected_atString

Optional

remote_idString

Optional

sourceString

Optional

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

applied_atString

Optional

candidateString

Required

credited_toString

Optional

current_stageString

Optional

jobString

Required

reject_reasonString

Optional

rejected_atString

Optional

remote_idString

Optional

sourceString

Optional

Lever

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Required

Supported POST Body Parameters

applied_atString

Optional

candidateString

Required

credited_toString

Optional

current_stageString

Optional

jobString

Required

reject_reasonString

Optional

rejected_atString

Optional

remote_idString

Optional

sourceString

Optional

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

candidateString

Optional

current_stageString

Optional

jobString

Optional

remote_idString

Optional

sourceString

Optional

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

applied_atString

Optional

candidateString

Required

current_stageString

Optional

jobString

Required

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

candidateString

Required

jobString

Required

remote_idString

Optional

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

applied_atString

Optional

candidateString

Required

current_stageString

Optional

jobString

Required

reject_reasonString

Optional

rejected_atString

Optional

remote_idString

Optional

sourceString

Optional

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

applied_atString

Optional

candidateString

Optional

jobString

Optional

remote_idString

Optional

sourceString

Optional

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/applications/{id}

Returns an Application 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

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString

Required

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

Response

JSON


{
  "id": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
  "remote_id": "98796",
  "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
  "job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
  "applied_at": "2021-10-15T00:00:00Z",
  "rejected_at": "2021-11-15T00:00:00Z",
  "source": "Campus recruiting event",
  "credited_to": "58166795-8d68-4b30-9bfb-bfd402479484",
  "current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea",
  "reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784",
  "custom_fields": {},
  "remote_was_deleted": true
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

sourceString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

reject_reasonString

remote_idString

sourceString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

sourceString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

jobString

remote_idString

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

sourceString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

sourceString

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

jobString

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Jobscore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

sourceString

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

remote_idString

sourceString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

credited_toString

current_stageString

jobString

reject_reasonString

sourceString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

credited_toString

current_stageString

jobString

rejected_atString

sourceString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

remote_idString

sourceString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

sourceString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

credited_toString

current_stageString

jobString

rejected_atString

remote_idString

sourceString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

applied_atString

candidateString

current_stageString

jobString

reject_reasonString

rejected_atString

remote_idString

sourceString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

current_stageString

jobString

reject_reasonString

rejected_atString

sourceString

Workday

Merge supports Passthrough Requests to this platform's API