Skip to main content
An Offer is proposed employment terms for a recipient before that recipient becomes a worker. It preserves the terms, deadline, delivery state, decision evidence, and downstream worker or onboarding link for that proposal.

​
Attributes

​
id
string
Unique identifier for the offer, e.g. ofr_8kY3pQmNvT2sW9xF.
​
object
string
The object type. Always offer.
​
workspace
string
Workspace ID that owns the offer.
​
status
string
Offer status. One of draft, sent, accepted, declined, expired, or voided.
​
recipient
object
Recipient name and email.
​
terms
object
Proposed role, employment constraints, compensations, and benefits. Employment includes allowed types, start date, and allowed countries.
​
position
string
Position ID linked to the offer, if any.
​
job
string
Job ID linked to the offer, if any.
​
expires
string
Timestamp when the offer expires.
​
delivery
object | null
Delivery summary for sent offers, including the candidate URL, first sent timestamp, latest delivery email status, last sent timestamp, and resend count.
​
decision
object | null
Candidate decision summary for accepted or declined offers. Accepted decisions include the frozen accepted terms, selected compensation and employment snapshots, and signer and request evidence.
​
document
object | null
Document or agreement summary associated with the offer. This is null in v1 until the offer document or agreement integration is added. Use decision.terms and decision.evidence for accepted-offer evidence.
​
worker
string | null
Worker ID created from the accepted offer, if conversion has happened.
​
onboarding
object | null
Onboarding summary created from the accepted offer, if conversion has happened.
​
metadata
object
Set of key-value pairs attached to the offer.
​
created
string
Timestamp of when the offer was created.
​
updated
string
Timestamp of when the offer was last updated.