Feed API
The Feed API allows you as a Jobylon-customer to retrieve job data in XML/JSON format and display it in your own interface. This is suitable for more advanced implementations than what our job widget can provide.
Our customer support can set up feeds on request. Once configured, you will receive a URL for the specific feed. The default content format is XML, but by appending ?format=json to any URL the content will be formatted in JSON.
You can find the XML schema for the response here: Job object schema
You can find an example of the XML response here: Job structure example
Name | Type | Description |
---|---|---|
id | integer | Job ID |
categories | array | Collection of Category |
company | object | Company object |
contact | object | Contact object |
departments | array | Collection of Department |
summary | string | Job summary |
descr | string | HTML-formatted string of text |
employment_type | string | Employment type |
experience | string | Experience level |
from_date | string | Job ad advertised from this date |
function | string | Job function |
language | string | Language used in job ad (ISO 639-1) |
locations | array | Collection of Location |
skills | string | HTML-formatted string of text |
slug | string | Job slug, without complete URL |
title | string | Job title |
to_date | string | Job ad advertised from to date |
dt_created | string | Datetime that job was created |
dt_modified | string | Datetime that job was last modified |
status_changed | string | Datetime when job status changed |
workspace_type | string | Workspace type |
video | object | Video object |
benefits | object | Benefits object |
internal_reference | object | Internal Reference |
owner | object | Owner object |
urls | object | URL object |
Name | Type | Description |
---|---|---|
id | integer | Category ID |
text | string | Category name |
Name | Type | Description |
---|---|---|
id | integer | Company ID |
cover | url | URL to cover image |
descr | string | HTML-formatted string of text |
industry | string | Company industry |
logo | url | URL to logo |
name | string | Company name |
slug | string | Company slug, without complete URL |
website | url | URL for company website |
Name | Type | Description |
---|---|---|
string | Email for contact | |
name | string | Full name of contact |
phone | string | Phone number for contact |
photo | url | URL to photo of contact |
Name | Type | Description |
---|---|---|
id | integer | Department ID |
desc | string | HTML-formatted string of text |
Name | Type | Description |
---|---|---|
area_1_short | string | Short name of city area, default to full name |
area_1 | string | Name of city area |
city | string | Name of city |
city_short | string | Short name of city, defaults to full name |
country | string | Country of location |
country_short | string | Country alpha-2 code |
municipality | string | Name of city municipality |
place_id | string | ID of location on Google maps |
postal_code | string | Postal code of location |
postal_code_short | string | Short postal code, default to full postal code |
text | string | Name or full address of location |
url | url | URL to location on Google maps |
Name | Type | Description |
---|---|---|
id | string | Video ID at source |
src | string | Source of video |
url | url | URL to video |
Name | Type | Description |
---|---|---|
id | integer | Benefit ID |
text | string | Benefit name |
Name | Type | Description |
---|---|---|
id | integer | ID of the job owner |
name | string | Full name of the job owner |
string | Email of the job owner |
Name | Type | Description |
---|---|---|
apply | url | URL to application form |
ad | url | URL to ad |
By using the feed metadata endpoint /feeds/<hash>/meta/ you can get info about how the different metadata of the feed
Name | Type | Description |
---|---|---|
categories | url | Endpoint to fetch the categories metadata |
companies | url | Endpoint to fetch the companies metadata |
departments | url | Endpoint to fetch the departments metadata |
experiences | url | Endpoint to fetch the experiences metadata |
functions | url | Endpoint to fetch the functions metadata |
locations | url | Endpoint to fetch the locations metadata |
layers_* | url | Endpoint to fetch the layers metadata |
NOTE layers are dynamic by nature. The metadata endpoint can provide information on how many there are.
All endpoints are paginated. Default pagination size is 10 and can be adjusted by the page_size query parameter.
The Maximum size is 300.
Name | Type | Description |
---|---|---|
count | integer | Number of categories on the feed |
next | url | Next url to query the data |
previous | url | Previous url to query the data |
results | array | Collection of CategoryMetadata |
Name | Type | Description |
---|---|---|
id | integer | Id of the category |
text | string | Name of the category |
company | integer | Id of the company that the category belongs to |
Name | Type | Description |
---|---|---|
count | integer | Number of companies on the feed |
next | url | Next url to query the data |
previous | url | Previous url to query the data |
results | array | Collection of CompanyMetadata |
Name | Type | Description |
---|---|---|
id | integer | Id of the company |
name | string | Name of the company |
internal_name | string | Name of the company used internally in Jobylon |
Name | Type | Description |
---|---|---|
count | integer | Number of departments on the feed |
next | url | Next url to query the data |
previous | url | Previous url to query the data |
results | array | Collection of DepartmentMetadata |
Name | Type | Description |
---|---|---|
id | integer | Id of the department |
name | string | Name of the department |
company | integer | Id of the company the department belongs to |
label | string | How the department is labeled in the company |
label_plural | string | How the department is labeled in the company in plural |
Name | Type | Description |
---|---|---|
count | integer | Number of experiences on the feed |
next | url | Next url to query the data |
previous | url | Previous url to query the data |
results | array | Collection of ExperienceMetadata |
Name | Type | Description |
---|---|---|
id | integer | Id of the experience |
text | string | Name of the experience |
Name | Type | Description |
---|---|---|
count | integer | Number of functions on the feed |
next | url | Next url to query the data |
previous | url | Previous url to query the data |
results | array | Collection of FunctionMetadata |
Name | Type | Description |
---|---|---|
id | integer | Id of the function |
text | string | Name of the function |
Name | Type | Description |
---|---|---|
count | integer | Number of locations on the feed |
next | url | Next url to query the data |
previous | url | Previous url to query the data |
results | array | Collection of LocationMetadata |
Name | Type | Description |
---|---|---|
location | string | Name of the location |
area | string | Name of the area of the location |
company | integer | Id of the company the location belongs to |
Name | Type | Description |
---|---|---|
count | integer | Number of layers on the feed |
next | url | Next url to query the data |
previous | url | Previous url to query the data |
results | array | Collection of LayersMetadata |
Name | Type | Description |
---|---|---|
id | integer | Id of the layer |
text | string | Name of the layer |
company | integer | Id of the company the layer belongs to |
dimension | integer | Dimension that layer belongs to |
layer_name | string | The name of the dimension of the layer |
layer_name_plural | string | The plural name of the dimension of the layer |