Merge ATS - Offers

Offers

The Offer object is used to represent an offer for a candidate's application specific to a job.

Properties

idUUID

remote_idString

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

The datetime that this object was modified by Merge.

applicationUUID

The application who is receiving the offer.

The Application object

The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.

Properties

idUUID

remote_idString

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

The datetime that this object was modified by Merge.

candidateUUID

The candidate applying.

jobUUID

The job being applied for.

applied_atDateTime (ISO 8601)

When the application was submitted.

rejected_atDateTime (ISO 8601)

When the application was rejected.

offersArray

sourceString

The application's source.

credited_toUUID

The user credited for this application.

screening_question_answersScreeningQuestionAnswer[]

current_stageUUID

The application's current stage.

reject_reasonUUID

The application's reason for rejection.

remote_was_deletedBoolean

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject

remote_dataRemoteData[]

creatorUUID

The user who created the offer.

remote_created_atDateTime (ISO 8601)

When the third party's offer was created.

closed_atDateTime (ISO 8601)

When the offer was closed.

sent_atDateTime (ISO 8601)

When the offer was sent.

start_dateDateTime (ISO 8601)

The employment start date on the offer.

statusEnum

The offer's status. Possible values include: DRAFT, APPROVAL-SENT, APPROVED, SENT, SENT-MANUALLY, OPENED, DENIED, SIGNED, DEPRECATED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

remote_was_deletedBoolean

field_mappingsObject

remote_dataRemoteData[]

The RemoteData object

The RemoteData object is used to represent the full data pulled from the third-party API for an object.

Properties

pathString

The third-party API path that is being called.

dataAny

The data returned from the third-party for this object in its original, unnormalized format.

GET

/offers

https://api.merge.dev/api/ats/v1/offers

APAC

Returns a list of Offer objects.

Query & path parameters

application_idString

Optional

If provided, will only return offers for this application.

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.

creator_idString

Optional

If provided, will only return offers created by this user.

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

include_remote_dataBoolean

Optional

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

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

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. The maximum limit is 100.

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 for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

statusString

Optional

If provided, will only return offers with this status. Options: ('DRAFT', 'APPROVAL-SENT', 'APPROVED', 'SENT', 'SENT-MANUALLY', 'OPENED', 'DENIED', 'SIGNED', 'DEPRECATED')

Field support by integration

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

Ashby

Greenhouse

iCIMS

Jobvite

Lever

Oracle Taleo

SAP SuccessFactors

SmartRecruiters

Teamtailor

UKG Pro Recruiting

Workable

Workday

GET

/offers/{id}

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

APAC

Returns an Offer object with the given id.

Query & path parameters

expandString

Optional

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

idUUID

Required

include_remote_dataBoolean

Optional

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

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

Field support by integration

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

Ashby