Offers

An offer is extended to a candidate when the hiring manager is ready to hire that candidate. A candidate must accept the offer before he/she is hired against a position of a job. In the offer negotiation process, when the terms of the offer changed, a separate, new offer is created and extended to the candidate and the old offer is abandoned. Although offers can only be created within SmartRecruiters, you can retrieve offers for a specific using the Offers API.

{
  "id": "string",
  "status": "CREATED",
  "createdOn": "2021-07-27T06:30:32.765Z",
  "updatedOn": "2021-07-27T06:30:32.765Z",
  "properties": {
    "additionalProp1": "string"
  },
  "actions": {
    "candidate": {
      "url": "string",
      "method": "GET"
    },
    "job": {
      "url": "string",
      "method": "GET"
    },
    "details": {
      "url": "string",
      "method": "GET"
    }
  }
}

The offer object

id string
Unique offer identifier

status string
Status of the offer. Possible values: CREATED, PENDING_APPROVAL, APPROVED, NOT_APPROVED, PENDING_ACCEPTANCE, ACCEPTED, NOT_ACCEPTED, ABANDONED.

createdOn date-time
The time when the offer was created. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

updatedOn date-time
The time when the offer was updated. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

properties object
Custom defined candidate properties of the offer. The number of custom properties contain in the object depends on the offer

  • properties.{exampleLabel1} string
    Key-value pairs that describe the candidate property and the value of the property of the offer

actions object
Different resources of the offer, their respective location and method to retrieve them

  • actions.candidate object
    Candidate resource location of the job and method to retrieve the resource
    • actions.candidate.url string
    • actions.candidate.method string
  • actions.job object
    Job publications resource location of the job and method to retrieve the resource
    • actions.job.url string
    • actions.job.method string
  • actions.details object
    • actions.details.url string
    • actions.details.method string