get https://{subdomain}.workable.com/spi/v3/candidates//offer
Returns the offer related data of the given candidate. Required scope: r_candidates. Accessible with all token types.
Results
Calling the /candidates/:id/offer endpoint returns a JSON array of the candidate's latest offer.
This is an example object that has the following keys (response may differ per account):
| key | type | description |
|---|---|---|
| candidate/id | string | The candidate key |
| candidate/name | string | The candidate full name |
| created_at | date | The offer creation date |
| document_variables | array | The document variables of the offer |
| documents | array | The documents related to the offer (Offer letter & other documents) |
| state | string | The state of the offer ('accepted', 'rejected' etc.) |
Document variables
The document_variables array contains variable objects in the following format:
| key | type | description |
|---|---|---|
| document_variable/name | string | The name of the document variable |
| document_variable/slug | string | Slug of the document variable |
| value/body | string | The value body (in all cases except salary type variables) |
| value/data | object | The value data (only in salary type variables) |
| value/data/amount | integer | The amount of salary |
| value/data/frequency | string | The frequency of the amount of salary |
| value/data/currency_iso | string | The currency of salary |
| value/data/cached_value | string | The salary details in plain language |
Documents
The documents array contains offer related documents in the following format:
| key | type | description |
|---|---|---|
| name | string | The name of the filename |
| preview_url | string | The full url to the document |
| kind | string | The type of the document ("Offer" etc.) |