---
title: "Search offers"
method: GET
path: "/offers"
tags: ["offers"]
---

# Search offers

`GET /offers`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/offers`
- Auth: one of:
  - API key in header `x-smarttoken`
  - OAuth 2
    - Authorization code: `https://www.smartrecruiters.com/identity/oauth/allow`
    - Token URL: `https://api.smartrecruiters.com/identity/oauth/token` scopes: `candidates_offers_read`

This endpoint can only be used with the credentials created for the user with the Extended or Admin system roles.

## Query parameters

- `limit` integer
- `offset` integer
- `createdAfter` string, date-time
- `createdBefore` string, date-time
- `age` string
- `status` string[]

## Response `200`

Offers matching search criteria.

- Offers
  - `limit` integer
  - `offset` integer
  - `totalFound` integer, required
  - `content` Offer[], required
    - `id` string, required
    - `status` 'CREATED' | 'PENDING_APPROVAL' | 'APPROVED' | 'NOT_APPROVED' | 'PENDING_ACCEPTANCE' | 'ACCEPTED' | 'NOT_ACCEPTED' | 'ABANDONED', required
    - `createdOn` string, date-time, required
    - `updatedOn` string, date-time, required
    - `properties` object
    - `propertiesDetails` FieldDetails[]: Additional details about the properties, including their origin and external code.
      - `mergeFieldKey` string, required: Key of the merge field used in the offer document template.
      - `key` string, required: Key of the underlying property.
      - `id` string, nullable: Identifier of the underlying property definition, null for ad hoc properties.
      - `origin` 'JOB_FIELD' | 'APPLICATION_FIELD' | 'OFFER_AD_HOC_FIELD', required: Origin of the property.
      - `value` FieldDetailsValue, required
        - `id` string, nullable: Identifier of the selected value, applicable to select-type properties.
        - `label` string, nullable: Human-readable label of the value.
        - `externalCode` string, nullable: External code of the selected value, if defined.
    - `actions` object, required
      - `candidate` Action, required
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
      - `job` Action
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
      - `details` Action, required
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required

## Other responses

- `403`: with code **NO_ACCESS_TO_OFFERS** when not permitted to see offers

---

[API](https://skmtc.dev/smartrecruiters/apis/offers-api-version-1.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/offers-api-version-1/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/offers-api-version-1/revisions/9e94f2223496?raw)