Changelog
Back to All

Configuration API - Expose External Source Metadata on Job and Candidate Properties

October 13th, 2026

Description

Exposes reference on job and candidate property definition responses. This field links a SmartRecruiters property to its originating entity in an external system (e.g. SuccessFactors).

What is reference?

reference is a read-only object present on properties managed by external integrations. It contains two fields:

  • type — the type of the external entity (e.g. "picklist").
  • code — the stable identifier of that entity in the source system (e.g. "ecPhoneType").

This field is read-only: it is set by the SuccessFactors integration only and cannot be modified through the SmartRecruiters API.

Configuration API

Changed

  • GET /configuration/job-properties — each item now includes reference when the property originates from an external source.
  • GET /configuration/job-properties/{id} — response now includes reference when the property originates from an external source.
  • GET /configuration/candidate-properties — each item now includes reference when the property originates from an external source.
  • GET /configuration/candidate-properties/{id} — response now includes reference when the property originates from an external source.

Example property with reference:

{
  "id": "abc123",
  "label": "Phone Type",
  "key": "phoneType",
  "reference": {
    "type": "picklist",
    "code": "ecPhoneType"
  }
}

Example property without reference (field absent when not managed externally):

{
  "id": "def456",
  "label": "Department",
  "key": "department"
}

Impact

No breaking changes. reference is an additive, read-only field on existing property definition schemas. Existing clients that do not read it are unaffected.

References