---
title: "Search Offer Letters"
method: GET
path: "/api/v1/offer_letters"
tags: ["Offers (Deprecated)"]
deprecated: true
---

# Search Offer Letters

`GET /api/v1/offer_letters`

> **Deprecated.**

Search Offer Letters - Offer Letters are the letters that are sent to candidates.

## Query parameters

- `filters` object
  - `ids` string — Comma separated list of Xpand Offer IDs
  - `offer_ids` string — Comma separated list of Client Offer IDs
  - `user_ids` string — Comma separated list of Xpand User IDs
  - `statuses` string[] — Comma separated list of Offer Statuses
- `page` integer

## Response `200`

The request has succeeded.

- object
  - `data` ResponsesOfferLetterList[], required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `offer_id` string, required — Unique ID of the Offer
    - `job_application_id` string, required — Unique ID of the Job Application
    - `office_location_id` object, required — JSON where key is name of external service, e.g. {'HRIS_ID': 'NEWYORK'. There must be an office location in Xpand with a matching employee id. See reference values here for existing office location external ids
      - `workday` string
    - `start_date` string, YYYY-MM-DD, required
    - `legal_entity` string — See reference values here for existing legal entity values.
    - `job_title` string — Job Title of the offer
    - `currency` string — ISO 4217 Currency Code
    - `base_salary` integer — Basic Salary
    - `end_date` string, YYYY-MM-DD
    - `induction_date` string, YYYY-MM-DD
    - `expiration_date` string, YYYY-MM-DD
    - `offer_dispositioned` string — dispositioning the offer
    - `campus` string
    - `compensation` integer — Total compensation of the offer (Base + Bonus + Allowes)
    - `non_compete_duration` integer
    - `supplemental_non_compete_duration` integer
    - `flsa_status` string — Exempt/Non-Exempt NY/CA wage forms
    - `respond_by_date` string, YYYY-MM-DD
    - `attorney_only` boolean
    - `confidential` boolean
    - `regulated` boolean
    - `regulated_status` string
    - `smcr` boolean — identify if someone is Senior Manager
    - `job_profile_id` string
    - `business_unit_id` string
    - `department_code` string
    - `position_type` string
    - `pay_rate` string
    - `job_level` string
    - `cost_center_id` string
    - `time_type` string
    - `employee_type` string
    - `job_code` string
    - `target_salary` integer
    - `max_salary` integer
    - `rsu` integer
    - `annual_bonus_percent` integer
    - `signing_bonus_amount` integer
    - `commission_amount` integer
    - `car_allowance` integer
    - `relocation` boolean
    - `relocation_flex_allowance` integer
    - `work_from_home` boolean
    - `immigration` boolean
    - `visa_sponsorship_notes` string
    - `urgent` boolean
    - `is_exempt` boolean
    - `notes` string
    - `documents` ModelsDocument[]
      - `document_type` string
      - `document_number` string
      - `document_title` string
      - `document_description` string
      - `issuer` string
      - `issuer_city` string
      - `issuer_state` string
      - `issuer_country` string
      - `issued_date` string, YYYY-MM-DD
      - `expiry_date` string, YYYY-MM-DD
      - `attachments` ModelsAttachment[]
        - `file_name` string
        - `file_content_base64` string, Base64
        - `responses` object — Responses provided in PDF form fields (only present when attachment is a PDF with form fields)
          - `field_name_1` string
          - `field_name_2` string

---

[API](https://skmtc.net/xpand-io/apis/xpand-api.md) · [All operations](https://skmtc.net/xpand-io/apis/xpand-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xpand-io/xpand-api/versions/85bece7875fd/schema)