Retrieve all your job listings

Important

The base URL here is https://api.flatchr.io

Request

GET /company/{companyId}/vacancies

Parameters

Parameter	In	Type	Required	Description	Example
companyId	path	string	✔️	Company identifier	Wy3EOp2NP3p1KMq8
fields	query	string		Optional information	address

Available field values

Fields allow you to retrieve information associated with job listings.

Values should be added to the fields URL parameter, separated by commas.

Name	Description	Data type
address	Job listing address	Address
tags	Tags	Tags

Filters for listings

You can filter listings by status.

Name	Description	Data type
status	Listing status	Vacancy status
offer_id	Distribution channel (career site or intranet)

Listings published on the intranet have offer_id 152; listings published on the career site have offer_id 98.

Request examples

Without fields

cURL request

curl -X GET https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/vacancies

With fields

cURL request

curl -X GET https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/vacancies?fields=address

Intranet listings

cURL request

curl -X GET https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/vacancies?fields=items&offer_id=152

Career site listings

cURL request

curl -X GET https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/vacancies?fields=items&offer_id=98

Response

Name	Type	Description
id	string	Identifier
vacancy_id	string	Listing ID
slug	string	Listing slug
reference	string	Listing reference
title	string	Listing title
description	string	Company description
experience	integer	Years of experience required
mission	string	Job description
profile	string	Required candidate profile
salary	integer	Salary for the position
status	integer	Listing status
language	enum	Language e.g. fr_FR
tags	[tag]	Array of tags
contract_type_id	integer	Contract type ID
education_level_id	integer	Education level required ID
activity_id	integer	Industry sector ID
channel_id	integer	Channel ID
metier_id	integer	Job category ID
company_id	integer	Company ID
mensuality	enum (y,m,d,h)	Salary payment frequency (year, month, day, hour)
apply_url	url
currency	enum	Currency e.g. "EUR"
created_at	timestamp	Listing creation date
updated_at	timestamp	Listing last update date
start_date	timestamp	Contract start date
end_date	timestamp	Contract end date
driver_license	boolean	Driving license required
remote	enum	Remote work ("notime", "parttime", "fulltime")
handicap	boolean	Open to workers with disabilities
partial	boolean	Part-time position
kanban	boolean
meta_title
meta_description
meta_tags
options	options
contract_type	string	Contract type
education_level	string	Education level required
activity	string	Industry sector
channel	string	Channel
metier	string	Job category
address	address
adressFormatted	string	Company address
company	company
slug_mail	string	Email slug for application submissions
questions	[question]	Array of questions

Response example

View example

[
    {
        "id": "eoLm5NdDXmdAGbZQ",
        "vacancy_id": 1701,
        "slug": "eolm5nddxmdagbzq-archiveur-de-lampes",
        "reference": null,
        "title": "Archiveur de lampes",
        "description": "<p>...</p>",
        "experience": 2,
        "mission": "<p>...</p>",
        "profile": "<p>...</p>",
        "salary": "1800",
        "status": 1,
        "language": "fr_FR",
        "contract_type_id": 1,
        "education_level_id": 2,
        "activity_id": 21,
        "channel_id": 8,
        "metier_id": 85,
        "company_id": 59,
        "mensuality": "m",
        "apply_url": null,
        "currency": "EUR",
        "created_at": "2023-05-10T06:40:59.131Z",
        "updated_at": "2023-05-10T06:40:59.145Z",
        "start_date": null,
        "end_date": null,
        "driver_license": false,
        "remote": "notime",
        "handicap": false,
        "partial": false,
        "kanban": true,
        "meta_title": null,
        "meta_description": null,
        "meta_tags": null,
        "options": {
          "required": ["email", "resume", "motivation"],
          "optionals": ["phone", "social_links"],
          "desactivated": ["indeed"],
          "motivationType": "text"
        },
        "slug_mail": "v81n3d",
        "video_url": "",
        "show_address": true,
        "show_contract_date": true,
        "show_contract_type": true,
        "show_salary": true,
        "worker_status": "supervisor",
        "skills": "Merchandising;Négociation"
    }
]