EIeightfold
Offer

Get Offer

Changed on

Given an Offer id, it returns all attributes of the Offer

get/api/v2/ats/offers/{offerId}

Request

Path parameters

offerIdstring required

ID of an offer in Eightfold

Query parameters

versionstring

version of the offer

macroIdsstring

Comma-separated list of macro variable IDs to evaluate and include in the response customInfo.

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

createdAtinteger nullable

Timestamp of when the offer was created

stockVestingFrequencystring nullable

Stock vesting frequency

versionsstring[] nullable

All versions of the offer

payGradeExternalIdstring nullable

External ID of the pay grade

stockOptionsTypestring nullable

Type of stock options

offerStatusstring nullable

status of the offer

profileIdstring nullable

unique identifier for profile

candidateAddressstring nullable

Candidate address

currencystring nullable

Currency for compensation

versionstring nullable

Version of the offer

groupIdstring nullable

group id

relocationBonusnumber float nullable

Relocation bonus amount

jobTitlestring nullable

Job title

workplaceType'remote_global' | 'remote_local' | 'hybrid' | 'onsite' nullable

Workplace type. Possible values: ['remote_global', 'remote_local', 'hybrid', 'onsite']

displayOfferIdstring nullable

Offer display id

payGradeIdinteger nullable

Pay grade of the offer

variableBonusnumber float nullable

Variable bonus amount

notestring nullable

Additional notes

customInfoobject nullable

Custom info

jobLocationstring nullable

Job location

bonusPayFrequencystring nullable

Bonus pay frequency

joiningDatestring nullable

Joining date

offerIdinteger nullable

Offer id

templateIdinteger nullable

Template id of the template used to create the offer

countryCodestring nullable

Country code

offerLetterobject nullable

Offer letter details

stockOptionsDescriptionstring nullable

Stock options description

candidateEmailstring nullable

Candidate email address

visaTypestring nullable

Visa type

isPeopleManagerRoleboolean nullable

Whether this is a people manager role

stockOptionsTotalVestingYearsinteger nullable

Total years for stock options vesting

isRehireboolean nullable

Whether this is a rehire

watchersstring[] nullable

Watchers

updatedAtinteger nullable

Timestamp of when the offer was last updated

salaryAmountnumber float nullable

Base salary amount

shiftAllowancenumber float nullable

Shift allowance amount

stockOptionsAmountnumber float nullable

Stock options amount

totalCompensationnumber float nullable

Total compensation amount

createdBystring nullable

User email who created the offer

basePayFrequencystring nullable

Base pay frequency

candidateFullNamestring nullable

Candidate full name

joiningBonusnumber float nullable

Joining bonus amount

stockOptionsPercentageVestingstring nullable

Stock options vesting percentage

positionIdinteger nullable

job id

stockVestingStartDatestring nullable

Stock vesting start date

applicationIdinteger nullable

application id

Changes

  • 9a8b3a927e93Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status