Offers

The Offer object is used to represent an offer for an application.

The Offer object

Properties


idString
Optional

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

applicationString
Optional
The application who is receiving the offer.

creatorString
Optional
The user who created the offer.

remote_created_atString
Optional
When the third party's offer was created.

closed_atString
Optional
When the offer was closed.

sent_atString
Optional
When the offer was sent.

start_dateString
Optional
The employment start date on the offer.

statusEnum
Optional
The offer's status. Possible values include: DRAFT, APPROVAL-SENT, APPROVED, SENT, SENT-MANUALLY, OPENED, DENIED, SIGNED, DEPRECATED, or - in cases where there is no clear mapping - the original value passed through.

remote_dataRemoteData[]
Optional

The Offer object

{
  "id": "dd85625c-6a59-446f-a317-6de64d83bae7",
  "remote_id": "9876",
  "application": "2872ba14-4084-492b-be96-e5eee6fc33ef",
  "creator": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
  "remote_created_at": "2021-10-15T00:00:00Z",
  "closed_at": "2021-10-16T00:00:00Z",
  "sent_at": "2021-10-15T00:00:00Z",
  "start_date": "2021-11-15T00:00:00Z",
  "status": "SENT",
  "remote_data": [
    {
      "path": "/offers",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/offers

Returns a list of Offer objects.


Query & Path Parameters


application_idString
Optional
If provided, will only return offers for this application.

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.

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_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": "dd85625c-6a59-446f-a317-6de64d83bae7",
      "remote_id": "9876",
      "application": "2872ba14-4084-492b-be96-e5eee6fc33ef",
      "creator": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
      "remote_created_at": "2021-10-15T00:00:00Z",
      "closed_at": "2021-10-16T00:00:00Z",
      "sent_at": "2021-10-15T00:00:00Z",
      "start_date": "2021-11-15T00:00:00Z",
      "status": "SENT",
      "remote_data": [
        {
          "path": "/offers",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

sent_atString

statusEnum

creatorString

start_dateString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

remote_dataRemoteData[]

remote_created_atString

statusEnum

remote_idString

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

statusEnum

start_dateString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

sent_atString

statusEnum

start_dateString

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

sent_atString

statusEnum

creatorString

start_dateString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

sent_atString

statusEnum

creatorString

remote_idString
GET

/offers/{id}

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.

idString
Required

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

Response

{
  "id": "dd85625c-6a59-446f-a317-6de64d83bae7",
  "remote_id": "9876",
  "application": "2872ba14-4084-492b-be96-e5eee6fc33ef",
  "creator": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
  "remote_created_at": "2021-10-15T00:00:00Z",
  "closed_at": "2021-10-16T00:00:00Z",
  "sent_at": "2021-10-15T00:00:00Z",
  "start_date": "2021-11-15T00:00:00Z",
  "status": "SENT",
  "remote_data": [
    {
      "path": "/offers",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

sent_atString

statusEnum

creatorString

start_dateString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

remote_dataRemoteData[]

remote_created_atString

statusEnum

remote_idString

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

statusEnum

start_dateString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

sent_atString

statusEnum

start_dateString

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

sent_atString

statusEnum

creatorString

start_dateString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


closed_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

sent_atString

statusEnum

creatorString

remote_idString