SmartRecruiters Jobs Feed Implementation Guide – Jobs API

Project Scope

Purpose

This document defines the requirements and process for implementing a Jobs Feed integration between SmartRecruiters Recruiting and Radancy Talent Acquisition Cloud (TAC).

Scope Overview

The Jobs Feed serves as the primary source of truth for open job requisitions displayed on the Radancy Career Site and supports downstream Radancy modules.

Additional integrations may be required based on the Radancy modules under contract, including but not limited to CRM, Employee Referrals, Hiring Events, Screening & Scheduling, Insights & Analytics, and Programmatic AdTech.

Out of Scope

This is a one-way integration from SmartRecruiters Recruiting to Radancy. This document covers job requisition data only. Applicant data is out of scope and is handled separately if contracted.

Integration Options Overview

SmartRecruiters supports two job integration methods:

  1. Posting API (API Key)
    • Used for publicly available job postings
    • Standard approach for career site integrations
  2. Jobs API (OAuth 2.0)
    • Used when OAuth authentication is required
    • Supports scoped access via SmartRecruiters credentials

This document covers the Jobs API (OAuth 2.0) integration.

When to Use Jobs API

Use this integration when:

  • OAuth authentication is required
  • API key cannot be used
  • Client requires scoped or secure access
  • Internal or non-public job data is needed

Integration Summary

Integration Details

  • Integration Type: API-based job feed
  • Integration Method: SmartRecruiters Jobs API
  • Data Direction: SmartRecruiters β†’ Radancy
  • Data Format: JSON
  • Authentication: OAuth 2.0 Client Credentials
  • Refresh Frequency: Up to four imports per day (standard), configurable based on client requirements and job volume

Data Retrieval Model

The integration retrieves job data using a structured API model:

  1. Retrieve job list using Jobs API
  2. Retrieve job details (if required)
  3. Normalize data
  4. Ingest into Radancy pipeline

High-Level Integration Workflow

Step 1 – Obtain OAuth Access Token

Exchange Client ID and Client Secret for an access token.

Step 2 β€” Retrieve Jobs

Step 3 β€” Retrieve Job Details (If Required)

Step 4 β€” Normalize & Ingest

  • Merge data
  • Map fields
  • Send to ingestion pipeline

Authentication & Security

OAuth 2.0 Client Credentials

SmartRecruiters uses OAuth 2.0 Client Credentials for machine-to-machine integrations.

Credential Setup

In SmartRecruiters:

  • Navigate to Settings / Admin β†’ Credential Manager
  • Create OAuth Client ID

Required Configuration

  • Scope: jobs_read
  • System Role: Required and must allow job access
  • Access Group: optional

Critical Role Requirement

Even if the correct scope (jobs_read) is selected:
If the assigned System Role does not include job access, the API may:

  • Return incomplete data
  • Return empty responses

Credentials Provided

  • Client ID
  • Client Secret

Token Request

client_secret_post

client_secret_basic

Token Response Example

Authorization Header

SmartRecruiters API Endpoints Used

  • Search Jobs

    Headers

    Query Parameters

    ParameterDescription
    limitNumber of records per request
    offsetStarting position (if supported)
    filtersOptional filtering

    No tenant-specific identifiers required.

    Example Request

    2. Get Job Details

    Job Detail Retrieval Guidance

    Use /jobs/{jobId} when:

    • Required fields are missing from list response
    • Full job content is needed
    • Additional enrichment is required

Job Eligibility Logic

Jobs are considered active when:

  • Returned by the Jobs API
  • Match defined filtering rules

Job Status Handling

Unlike Posting API:

  • Jobs API does not use destination filtering

Instead:

  • Job inclusion depends on the API response and any configured filters (e.g., open jobs only vs all jobs). This must be defined during implementation.

Pagination Handling

SmartRecruiters supports multiple pagination methods.

Supported

  • limit
  • offset
  • cursor-based (nextPageId, if returned)

Recommended Approach

  • Use limit for batch size
  • Continue until all jobs retrieved
  • Follow response-based pagination

Pagination behavior may vary by endpoint. The integration should follow the pagination method returned in the API response.

Job Identifier Handling (Multi-Location Support)

By default, SmartRecruiters job data includes a refNumber field, which may be shared across multiple job postings (for example, when a job is posted in multiple locations).

To ensure each job is processed uniquely, Radancy uses the id field as the primary job identifier.

  • refNumber β†’ may be duplicated across postings
  • id β†’ unique per job posting

Result:

  • Prevents duplicate job failures
  • Ensures all job locations are properly captured

Example:

A single job posted in multiple locations may:

  • Share the same refNumber across postings
  • Have different id values per posting

Using id ensures each location is processed as a separate job.

Data Differences vs Posting API

 Posting APIJobs API
Data TypePublic postingsJob records
AuthAPI KeyOAuth
ContentPosting contentJob data
FilteringDestination-basedAPI-based

Important Notes

Jobs API data depends on:

  • OAuth scope
  • Assigned role

Some posting-specific fields (such as formatted job descriptions or apply URLs) may differ from Posting API responses and should be validated during implementation.

The Jobs API may also return a broader dataset than the Posting API. Filtering logic (e.g., open jobs only vs. all jobs) should be confirmed during implementation to ensure alignment with business requirements.

Required Client Setup

FieldDescription
Client IDOAuth credential
Client SecretOAuth credential
API Host URLhttps://api.smartrecruiters.com
Scopejobs_read
System RoleMust allow job access
Optional HeadersAccept-Language

Job Feed Data Requirements

Below is a list of required, recommended and optional fields. The customer/ATS must provide the fields and data in the format to be displayed on their career site. Please note that certain fields (not all are displayed on your career site) will be required/recommended to support your Radancy TAC platform (i.e. CRM, Employee Referrals, Hiring Events, Programmatic AdTech, etc.)

FieldDescriptionRequired
Company NameName of your organizationRecommended
Company ID / Org IDIf your ATS supports multiple instancesOptional
Job TitleTitle of the jobYes
Job ID/Requisition Number

Unique Identifier

Note: Radancy uses the SmartRecruiters id field as the unique identifier for ingestion to support multi-location job handling. Display fields (e.g., requisition number) may be mapped separately.

Yes
Job CategoryCategory of jobYes
Job DescriptionOne or more fields containing all descriptive data including relevant HTML format. Include/define any separate Qualifications/Experience/Requirements/Company Profile, etc.)Yes

Primary Job Location

  • City
  • State/Province
  • Country
  • Postal Code
Preferable in separate individual fields for city, state, country and postal code of the primary locationYes
Additional Locations

Option 1 – Single field separated by consistent unique identifiers, such as semi-colons and commas. (Preferred)
<additional locations>city, state, country; city, state, country; city, state, country</additional locations>

Option 2 – In separate fields for each additional city, state and country.
<additional locations>city,state,country</additional locations>
<additional locations1>city1,state1,country1</additional locations1>
<additional locations2>city1,state1,country1</additional locations2>

Recommended
Application URLATS application URLYes
Job Posting DateDate job was created in ATSYes
Job StatusOpen/Closed/FilledRecommended
Job Shift1/2/3/Evening/WeekendRecommended
Job TypeType of job; FT/PT/PDRecommended
Job LevelSenior, Manager, Entry, etc.Recommended
LanguageLanguage requirementsRecommended
Facility NameIf multiple physical locationsRecommended
Brand/Division/DepartmentIf multiple brand/division/department namesRecommended
Business UnitIf multiple business unitsRecommended
SalarySalary info; Min – MaxYes
Remote StatusYes/No – enhances candidate search experience on career site; a primary job location is still requiredRecommended
Job ProfileStandardized job title templates.Optional
Recruiter NameName of Primary RecruiterRecommended
Recruiter EmailEmail of Primary Recruiter. Required for CRM/ReferralsYes
Hiring Manager EmailEmail of Hiring ManagerOptional
Sourcer EmailEmail of SourcerOptional
Referral RewardDescription of the reward to be earned for a successful hireRecommended
Referral Featured JobYes/NoRecommended
Custom FieldsCustomer to provide use case descriptionOptional

Notes:

Referrals: If all correlated fields are included in the jobs feed integration, jobs are automatically published within the Employee Referrals dashboard (ready to refer). If any jobs are missing required data, they will instead be listed under β€œdraft” status requiring manual intervention by the customer (recruiter) to complete. Once completed, the job can then be published and β€œenabled” to begin referring. If any data is not available from your ATS, it is possible for Radancy to apply conditional logic to streamline workflow processes.

  • Fields can be defaulted to a standard selected value (e.g., Reward plan is for all jobs β€œ$500”)
  • Fields can be conditionally mapped based on other fields (e.g., if experience level is β€œEntry”, Reward plan is β€œ$100”, if experience level is β€œAdvanced”, Reward plan is β€œ$500”)

Please contact your assigned Digital Project Manager or Integration Specialist.

High-Level Implementation Timeline

High Level Jobs Implementation Timeline  
TaskOwnerDate/Timeline

Kickoff call

  • Discovery and documentation exchange.
  • Define action items.
Customer/ATS/Radancy-
Provide API Credentials or XML job feed to RadancyCustomer/ATS5-10 business days

Validate access to API or receipt of XML job feed

  • Review required fields and data format.
Radancy5-10 business days

Create integration connectors and import test data

  • During implementation, Radancy will recommend optimizations to the test feed and/or data as necessary.
  • Display test jobs on staging preview site.
Radancy5-10 business days

Customer UAT

  • Customer conducts testing on the staging preview site (full job posting appearance).
  • Customer to provide Radancy with feedback and revisions.
  • Repeat until customer approval is attained.
Customer/Radancy5-10 business days

Go Live Ready

  • Customer and Radancy to coordinate migration of integration work from staging/preview to production environment in accordance with your career site launch.
Customer/Radancy-

*Timeline is subject to change based on implementation variables.

 

 

Was this article helpful?
0 out of 0 found this helpful