v1
latestOpenAPI 3.0.22026-07-26191278525.6 KBOffer
Get Offer
Given an Offer id, it returns all attributes of the Offer
get/api/v2/ats/offers/{offerId}
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