Skip to main content

Job feed integration

  • Updated
Available in product
Prescreen Go Core Pro Ultimate
Available in product
Free Core Pro
Available in product
Core Pro
Available in product
Core Pro Ultimate
Available in product
Core Pro Ultimate
Available in product
Core Pro
Available in product
360°

The job feed allows you to pull all published jobs of your account. The following guide explains available parameters and structure of returned data.

1. Available formats

Following formats are available: JSON, XML, XML-CDATA

2. Request

https://subdomain.onlyfy.io/job/list/{handle}?format={format}

Subdomain: Every recruiter account has a unique subdomain.

3. Parameters

Parameter Values Default Description
handle*     Every recruiter account has a unique md5 handle
format* json,xml    
lang browser, de, en, hu, fr browser Defines the language of the widget interface. If set to ‘browser’ it uses the language of the current request-session.
sorting_mode alphabetic, date alphabetic  
sorting_dir ASC, DESC ASC  
start_display 0, 1, .... 0  
max_results 1, 2, ..., 250 20  
country_code de, at, uk, ...    
instance_id     Instance ID, a recruiter account can have multiple sub-instances (e.g. sub-companies, divisions etc.) Please contact your account manager for further details.
team_id     Team ID, depending on your company structure this can be a department (e.g. IT, Marketing), business location, etc.
city_id     Filter jobs from a specific city
industry_id     Filter jobs from a specific industry
distance     Based on given city_id, filters jobs within a specific km radius
department_id     ID of the field of work (e.g. Sales, IT, ...)
position_type_id     ID of the position type (e.g. Fulltime, ...)
seniority_id     ID of the seniority level (e.g. 3, ...)
cf[]     Array of custom defined field IDs
cfvid[]     Array of custom field value ids (same order as custom fields)
cfv[]     Array of custom field values (same order as custom fields)

* = mandatory

Example parameter string:

?format=json&sorting_mode=alphabetic&sorting_dir=ASC&start_display=10&max_results=10&country_code=at&city_id=5241&department_id=21&position_type_id=1&cf[]=138&cfv[]=example-value

4. Response

Example 1: JSON / single job, simple job description

{
	"company":"onlyfy",
	"totalResults":1,
	"currentStartDisplay":0,
	"jobs":[{
		"title":"Sales Manager",
		"handle":"rafsb85qgao0kokgc4skwwgswgkwg08",
		"showUrl":"https:\/\/subdomain.onlyfy.io\/candidate\/job\/show\/TEST-HANDLE\/rafsb85qgao0kokgc4skwwgswgkwg08",
		"template": {"id": 10,	"name": "Sales Manager"},
		"bannerUrl": "https:\/\/subdomain.onlyfy.io\/uploads\/company\/jobs\/1.jpg",
		"bannerFooterUrl": "https:\/\/subdomain.onlyfy.io\/uploads\/company\/job_banner_footer\/1.jpg",
		"department":{"id":21,"title":"Sales"},
		"city":{"id":5241,"title":"Vienna","country":"Austria","countryCode":"AT"},
		"positionType":{"id":1,"title":"Full-time"},
		"seniority":{"id":3,"title": "Berufserfahren"},
		"industry_id": 25,
		"startOfWork": "2016-01-01",
		"headcount": 1,
		"instance":{"id":1,"name":"External"},
		"team":{"id":1,"name":"Sales Vienna HQ"},
		"custom_data_fields": [{"id": 29,"name": "Department","form_label": "Department","value": "Sales"}],
		"description":"Example job description."
	}]
}

Example 2: JSON / single job, multiple content blocks (job descriptions)

{
	"company":"onlyfy",
	"totalResults":1,
	"currentStartDisplay":0,
	"jobs":[{
		"title":"Software Developer",
		"handle":"5q6vfzi2ixhc2sdlrhfm8irsb0yczzj",
		"showUrl":"https:\/\/subdomain.onlyfy.io\/candidate\/job\/show\/TEST-HANDLE\/5q6vfzi2ixhc2sdlrhfm8irsb0yczzj",
		"template": {"id": 11,	"name": "Developer"},
		"bannerUrl": "https:\/\/subdomain.onlyfy.io\/uploads\/company\/jobs\/1.jpg",
		"bannerFooterUrl": "https:\/\/subdomain.onlyfy.io\/uploads\/company\/job_banner_footer\/1.jpg",
		"department":{"id":9,"title":"IT"},
		"city":{"id":5241,"title":"Vienna","country":"Austria","countryCode":"AT"},
		"positionType":{"id":1,"title":"Full-time"},
		"seniority":{"id":3,"title": "Berufserfahren"},
		"industry_id": 25,
		"startOfWork": "2016-01-01",
		"headcount": 1,
		"instance":{"id":1,"name":"External"},
		"team":{"id":1,"name":"Sales Vienna HQ"},
		"custom_data_fields": [{"id": 29,"name": "Department","form_label": "Department","value": "Development"}],
		"description":{"job_content_1":"Intro text.", "job_content_2":"Example content."}
	}]
}

Example 3: XML / multiple jobs

<data>
	<company>onlyfy</company>
	<totalresults>2</totalresults>
	<currentstartdisplay>0</currentstartdisplay>
	<jobs>
		<job>
			<title>Sales Manager</title>
			<handle>rafsb85qgao0kokgc4skwwgswgkwg08</handle>
			<showurl>https://subdomain.onlyfy.io/candidate/job/show/TEST-HANDLE/rafsb85qgao0kokgc4skwwgswgkwg08</showurl>
			<template><id>10</id><name>Sales Manager</name></template>
			<bannerUrl>https://subdomain.onlyfy.io/uploads/company/jobs/1.jpg</bannerUrl>
			<bannerFooterUrl>https://subdomain.onlyfy.io/uploads/company/job_banner_footer/1.jpg</bannerFooterUrl>
			<department><id>21</id><title>Sales</title></department>
			<city><id>5241</id><title>Vienna</title><country>Austria</country><countryCode>AT</countryCode></city>
			<positiontype><id>1</id><title>Full-time</title></positiontype>
			<seniority><id>3</id><title>Berufserfahren</title></seniority>
			<industry_id>25</industry_id>
			<startOfWork>2015-09-14</startOfWork>
			<headcount>1</headcount>
			<instance><id>1</id><name>External</name></instance>
			<team><id>1</id><name>Sales Vienna HQ</name></instance>
			<custom_data_fields><custom_data_field><id>29</id><name>Department</name><form_label>Department</form_label><value>Sales</value></custom_data_field></custom_data_fields>
			<description><job_content_1>Intro text.</job_content_1><job_content_2>Example content.</job_content_2></description>
		</job>
		<job>
			<title>Software Developer</title>
			<handle>5q6vfzi2ixhc2sdlrhfm8irsb0yczzj</handle>
			<showurl>https://subdomain.onlyfy.io/candidate/job/show/TEST-HANDLE/5q6vfzi2ixhc2sdlrhfm8irsb0yczzj</showurl>
			<template><id>11</id><name>Developer</name></template>
			<bannerUrl>https://subdomain.onlyfy.io/uploads/company/jobs/1.jpg</bannerUrl>
			<bannerFooterUrl>https://subdomain.onlyfy.io/uploads/company/job_banner_footer/1.jpg</bannerFooterUrl>
			<department><id>9</id><title>IT</title></department>
			<city><id>5241</id><title>Vienna</title><country>Austria</country><countryCode>AT</countryCode></city>
			<positiontype><id>1</id><title>Full-time</title></positiontype>
			<seniority><id>3</id><title>Berufserfahren</title></seniority>
			<startOfWork>2015-09-14</startOfWork>
			<headcount>1</headcount>
			<instance><id>1</id><name>External</name></instance>
			<team><id>1</id><name>Sales Vienna HQ</name></team>
			<custom_data_fields><custom_data_field><id>29</id><name>Department</name><form_label>Department</form_label><value>Development</value></custom_data_field></custom_data_fields>
			<description><job_content_1>Intro text.</job_content_1></description>
		</job>
	</jobs>
</data>

Example 4: XML-CDATA / multiple jobs

<data>
	<company><![CDATA[onlyfy]]></company>
	<totalresults><![CDATA[2]]></totalresults>
	<currentstartdisplay><![CDATA[0]]></currentstartdisplay>
	<jobs>
		<job>
			<title><![CDATA[Sales Manager]]></title>
			<handle><![CDATA[rafsb85qgao0kokgc4skwwgswgkwg08]]></handle>
			<showurl><![CDATA[https://subdomain.onlyfy.io/candidate/job/show/TEST-HANDLE/rafsb85qgao0kokgc4skwwgswgkwg08]]></showurl>
			<template><id><![CDATA[10]]></id><name><![CDATA[Sales Manager]]></name></template>
			<bannerUrl><![CDATA[https://subdomain.onlyfy.io/uploads/company/jobs/1.jpg]]></bannerUrl>
			<bannerFooterUrl><![CDATA[https://subdomain.onlyfy.io/uploads/company/job_banner_footer/1.jpg]]></bannerFooterUrl>
			<department><id><![CDATA[21]]></id><title><![CDATA[Sales]]></title></department>
			<city><id><![CDATA[5241]]></id><title><![CDATA[Vienna]]></title><country><![CDATA[Austria]]></country><countryCode><![CDATA[AT]]></countryCode></city>
			<positiontype><id><![CDATA[1]]></id><title><![CDATA[Full-time]]></title></positiontype>
			<seniority><id><![CDATA[3]]></id><title><![CDATA[Berufserfahren]]></title></seniority>
			<industry_id><![CDATA[25]]></industry_id>
			<startOfWork><![CDATA[2015-09-14]]></startOfWork>
			<headcount><![CDATA[1]]></headcount>
			<instance><id><![CDATA[1]]></id><name><![CDATA[External]]></name></instance>
			<team><id><![CDATA[1]]></id><name><![CDATA[Sales-Vienna HQ]]></name></team>
			<custom_data_fields><custom_data_field><id><![CDATA[29]]></id><name><![CDATA[Department]]></name><form_label><![CDATA[Department]]></form_label>
				<value><![CDATA[Sales]]></value></custom_data_field></custom_data_fields>
			<description><job_content_1><![CDATA[Intro text.]]></job_content_1><job_content_2><![CDATA[Example content]]></job_content_2></description>
		</job>
		<job>
			<title><![CDATA[Software Developer]]></title>
			<handle><![CDATA[5q6vfzi2ixhc2sdlrhfm8irsb0yczzj]]></handle>
			<showurl><![CDATA[https://subdomain.onlyfy.io/candidate/job/show/TEST-HANDLE/5q6vfzi2ixhc2sdlrhfm8irsb0yczzj]]></showurl>
			<template><id><![CDATA[11]]></id><name><![CDATA[Developer]]></name></template>
			<bannerUrl><![CDATA[https://subdomain.onlyfy.io/uploads/company/jobs/1.jpg]]></bannerUrl>
			<bannerFooterUrl><![CDATA[https://subdomain.onlyfy.io/uploads/company/job_banner_footer/1.jpg]]></bannerFooterUrl>
			<department><id><![CDATA[9]]></id><title><![CDATA[IT]]></title></department>
			<city><id><![CDATA[5241]]></id><title><![CDATA[Vienna]]></title><country><![CDATA[Austria]]></country><countryCode><![CDATA[AT]]></countryCode></city>
			<positiontype><id><![CDATA[1]]></id><title><![CDATA[Full-time]]></title></positiontype>
			<seniority><id><![CDATA[3]]></id><title><![CDATA[Berufserfahren]]></title></seniority>
			<industry_id><![CDATA[25]]></industry_id>
			<startOfWork><![CDATA[2015-09-14]]></startOfWork>
			<headcount><![CDATA[1]]></headcount>
			<instance><id><![CDATA[1]]></id><name><![CDATA[External]]></name></instance>
			<team><id><![CDATA[1]]></id><name><![CDATA[Sales-Vienna HQ]]></name></team>
			<custom_data_fields><custom_data_field><id><![CDATA[29]]></id><name><![CDATA[Department]]></name><form_label><![CDATA[Department]]></form_label>
				<value><![CDATA[Sales]]></value></custom_data_field></custom_data_fields>
			<description><job_content_1><![CDATA[Intro text.]]></job_content_1><job_content_2><![CDATA[Example content]]></job_content_2></description>
		</job>
	</jobs>
</data>

 

 

Was this article helpful?
0 out of 1 found this helpful
Have more questions? Submit a request

Related articles