---
title: "Get Offer"
method: GET
path: "/api/v2/ats/offers/{offerId}"
tags: ["Offer"]
---

# Get Offer

`GET /api/v2/ats/offers/{offerId}`

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

## Path parameters

- `offerId` string, required

## Query parameters

- `version` string
- `macroIds` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- OfferSchema
  - `createdAt` integer, nullable — Timestamp of when the offer was created
  - `stockVestingFrequency` string, nullable — Stock vesting frequency
  - `versions` string[], nullable — All versions of the offer
  - `stockOptionsType` string, nullable — Type of stock options
  - `offerStatus` string, nullable — status of the offer
  - `profileId` string, nullable — unique identifier for profile
  - `candidateAddress` string, nullable — Candidate address
  - `currency` string, nullable — Currency for compensation
  - `version` string, nullable — Version of the offer
  - `groupId` string, nullable — group id
  - `relocationBonus` number, float, nullable — Relocation bonus amount
  - `jobTitle` string, nullable — Job title
  - `workplaceType` 'remote_global' | 'remote_local' | 'hybrid' | 'onsite', nullable — Workplace type. Possible values: ['remote_global', 'remote_local', 'hybrid', 'onsite']
  - `payGradeId` integer, nullable — Pay grade of the offer
  - `variableBonus` number, float, nullable — Variable bonus amount
  - `note` string, nullable — Additional notes
  - `customInfo` object, nullable — Custom info
  - `jobLocation` string, nullable — Job location
  - `bonusPayFrequency` string, nullable — Bonus pay frequency
  - `joiningDate` string, nullable — Joining date
  - `offerId` integer, nullable — Offer id
  - `templateId` integer, nullable — Template id of the template used to create the offer
  - `countryCode` string, nullable — Country code
  - `offerLetter` object, nullable — Offer letter details
  - `stockOptionsDescription` string, nullable — Stock options description
  - `candidateEmail` string, nullable — Candidate email address
  - `visaType` string, nullable — Visa type
  - `isPeopleManagerRole` boolean, nullable — Whether this is a people manager role
  - `stockOptionsTotalVestingYears` integer, nullable — Total years for stock options vesting
  - `isRehire` boolean, nullable — Whether this is a rehire
  - `watchers` string[], nullable — Watchers
  - `updatedAt` integer, nullable — Timestamp of when the offer was last updated
  - `salaryAmount` number, float, nullable — Base salary amount
  - `shiftAllowance` number, float, nullable — Shift allowance amount
  - `stockOptionsAmount` number, float, nullable — Stock options amount
  - `totalCompensation` number, float, nullable — Total compensation amount
  - `createdBy` string, nullable — User email who created the offer
  - `basePayFrequency` string, nullable — Base pay frequency
  - `candidateFullName` string, nullable — Candidate full name
  - `joiningBonus` number, float, nullable — Joining bonus amount
  - `stockOptionsPercentageVesting` string, nullable — Stock options vesting percentage
  - `positionId` integer, nullable — job id
  - `stockVestingStartDate` string, nullable — Stock vesting start date
  - `applicationId` integer, nullable — application id

---

[API](https://skmtc.net/eightfold/apis/api-server-v2-service-service.md) · [All operations](https://skmtc.net/eightfold/apis/api-server-v2-service-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eightfold/api-server-v2-service-service/versions/0fb26f4e41bf/schema)