GET | Details of a published job

Gewijzigd op Ma, 9 Mrt om 11:52 AM

GET https://{companyname}.tool2match.nl/api/jobs/puplished/[job_id]

TOOL2MATCH provides a set of public, read-only REST APIs to retrieve information about published job vacancies. All responses are returned in JSON format.

Base url

The base URL for API requests is:

https://{companyname}.tool2match.nl/api

Replace {companyname} with the specific company name.
If this URL does not work, use the URL you log in with, which follows the same structure.

Endpoints

Retrieve Published Job Information

Endpoint:

GET /api/jobs/published/[job_id]

Description:

This endpoint retrieves details of a published job vacancy by its job_id.

URL Paramaters:

- job_id (required): The unique ID of the job vacancy

Response Fields:

Field name	Description	Type of data
job_id	Job-id number of the vacancy	Integer
date_published	Publication date	String
job_title	Job title	String
job_short_title	Short description shown on the vacancy overview	String
jobsite_short_description	Short description shown on the vacancy page	String
job_description	Job description	String
contract_type_title	The contract-type E.g. "Fulltime", "Parttime"	String
employment_type_title	Type of employment E.g. "Freelance", "Internship", "Indefinite time"	String
job_type_name	Free input field Note: In the TOOL2MATCH interface this field is referred to as "Vacature-categorie".	String
num_hours_per_week	Number of hours per week for which the vacancy is open	String
max_range_meters	Maximum distance to the location of the department in kilometers	Integer
function_type_name	Type of function E.g. "Sales", "HR", "IT"	String
education_level	Level of education E.g. "Bachelors degree", "Masters degree"	String
sector_name	Type of sector/industry E.g. "Business services", "Industry", "Retail"	String
min_salary_euro	Minimum salary in euro's	Integer
max_salary_euro	Maximum salary in euro's	Integer
salary_period	Salary period Possible values: month, year, 4-weeks, hour	String
banner_image_url	Link to a banner image	String
job_thumbnail_url	Link to an image added to the job	String
video_link	Link to YouTube video	String
video_link_title	Title shown above the YouTube video	String
youtube_position	Location of the YouTube video Possible values: "below job", "above_job", "sidebar"	String
tags	Keywords/tags	String
custom_job_meta_title	Meta title	String
custom_job_meta_description	Meta description	String
tracking_pixel	Tracking pixel	String
department_name	Name of the department/location	String
department_street	Street in which the department is located	String
department_number	The house number where the department is located	String
department_zipcode	The zipcode related to the department/location	String
department_city	The city where the department is located	String
department_state	State in which the department is located	String
department_email	The e-mailadress of the department/location	String
department_phone	The phonenumber of the department/location	String
recruiter_name	Name of the contact person	String
recruiter_job_title	The job title of the contact person	String
recruiter_email	E-mailadres of the contact person	String
recruiter_mobile	Mobile number of the contact person	String
recruiter_phone	The phonenumber of the contact person	String
recruiter_linkedin	Link to LinkedIn profile of the contact person	String
recruiter_image_url	Link to the image of the contact person	String
recruiter_show_whatsapp	Show whatsapp icon on website	Boolean

Image accessibility fiels (WCAG)

To support WCAG accessibility guidelines, TOOL2MATCH allows users to define a title and alternative text (alt-text) for images and embedded videos. These fields help screen readers describe visual content to users with visual impairments.

When retrieving job data via the API, the following additional fields may be returned.

Response Fields:

Field name	Description	Type of data
banner_image_alt	Alternative text describing the banner image	String
banner_image_title	Title of the banner image	String
job_thumbnail_alt	Alternative text describing the vacancy image shown in the job overview	String
job_thumbnail_title	Title of the vacancy image shown in the job overview	String
recruiter_image_alt	Alternative text describing the image of the contact person	String
recruiter_image_title	Title of the image of the contact person	String
video_link_alt	Alternative text describing the YouTube video	String
video_link_title	Title shown above the YouTube video	String

CMS settings

In TOOL2MATCH, users can make various configurations. For example, users can determine which data should be displayed next to or above their vacancy. To keep this functionality available to users, close integration must be established with the fields below.

Response fields:

Field name	Description	Type of data
show_department_city_on_jobsite	Show city of department	boolean
show_employment_type_on_jobsite	Show type of employment	boolean
show_function_type_on_jobsite	Show type of function	boolean
show_distance_on_jobsite	Show maximum distance to the department in kilometers	boolean
show_department_name_on_jobsite	Show name of department	boolean
show_sector_on_jobsite	Show type of sector	boolean
show_salary_on_jobsite	Show salary	boolean
js_show_tags	Show tags	boolean
show_contract_type_on_jobsite	Show type of contract	boolean
show_education_level_on_jobsite	Show level of education	boolean
show_num_hours_per_week_on_jobsite	Show number of hours a week	boolean