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:
- Posting API (API Key)
- Used for publicly available job postings
- Standard approach for career site integrations
- 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:
- Retrieve job list using Jobs API
- Retrieve job details (if required)
- Normalize data
- 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
Parameter Description limit Number of records per request offset Starting position (if supported) filters Optional 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 API | Jobs API | |
| Data Type | Public postings | Job records |
| Auth | API Key | OAuth |
| Content | Posting content | Job data |
| Filtering | Destination-based | API-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
| Field | Description |
| Client ID | OAuth credential |
| Client Secret | OAuth credential |
| API Host URL | https://api.smartrecruiters.com |
| Scope | jobs_read |
| System Role | Must allow job access |
| Optional Headers | Accept-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.)
| Field | Description | Required |
| Company Name | Name of your organization | Recommended |
| Company ID / Org ID | If your ATS supports multiple instances | Optional |
| Job Title | Title of the job | Yes |
| 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 Category | Category of job | Yes |
| Job Description | One 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
| Preferable in separate individual fields for city, state, country and postal code of the primary location | Yes |
| Additional Locations | Option 1 β Single field separated by consistent unique identifiers, such as semi-colons and commas. (Preferred) Option 2 β In separate fields for each additional city, state and country. | Recommended |
| Application URL | ATS application URL | Yes |
| Job Posting Date | Date job was created in ATS | Yes |
| Job Status | Open/Closed/Filled | Recommended |
| Job Shift | 1/2/3/Evening/Weekend | Recommended |
| Job Type | Type of job; FT/PT/PD | Recommended |
| Job Level | Senior, Manager, Entry, etc. | Recommended |
| Language | Language requirements | Recommended |
| Facility Name | If multiple physical locations | Recommended |
| Brand/Division/Department | If multiple brand/division/department names | Recommended |
| Business Unit | If multiple business units | Recommended |
| Salary | Salary info; Min β Max | Yes |
| Remote Status | Yes/No β enhances candidate search experience on career site; a primary job location is still required | Recommended |
| Job Profile | Standardized job title templates. | Optional |
| Recruiter Name | Name of Primary Recruiter | Recommended |
| Recruiter Email | Email of Primary Recruiter. Required for CRM/Referrals | Yes |
| Hiring Manager Email | Email of Hiring Manager | Optional |
| Sourcer Email | Email of Sourcer | Optional |
| Referral Reward | Description of the reward to be earned for a successful hire | Recommended |
| Referral Featured Job | Yes/No | Recommended |
| Custom Fields | Customer to provide use case description | Optional |
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 | ||
| Task | Owner | Date/Timeline |
Kickoff call
| Customer/ATS/Radancy | - |
| Provide API Credentials or XML job feed to Radancy | Customer/ATS | 5-10 business days |
Validate access to API or receipt of XML job feed
| Radancy | 5-10 business days |
Create integration connectors and import test data
| Radancy | 5-10 business days |
Customer UAT
| Customer/Radancy | 5-10 business days |
Go Live Ready
| Customer/Radancy | - |
*Timeline is subject to change based on implementation variables.