---
title: "Get a list of available offer properties"
method: GET
path: "/configuration/offer-properties"
tags: ["configuration"]
---

# Get a list of available offer properties

`GET /configuration/offer-properties`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/configuration/offer-properties`
- 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: `configuration_read`

Get a list of available offer properties.

## Response `200`

- OfferPropertiesDefinition
  - `categories` OfferPropertiesCategory[]
    - `id` string
    - `properties` OfferPropertyDefinition[]
      - `key` string
      - `label` string
      - `required` boolean
      - `type` 'BOOLEAN' | 'COUNTRY' | 'CURRENCY' | 'DATE' | 'NUMBER' | 'PERCENT' | 'REGION' | 'TEXT' | 'USER' | 'SELECT'

## Other responses

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

---

[API](https://skmtc.dev/smartrecruiters/apis/configuration-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/configuration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/configuration-api/revisions/65491281a1a6?raw)
