Retrieve a job listing

Important

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

Request

You can retrieve a job listing using the following request:

GET /vacancy/{vacancyId}

Parameters

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

Fields

Below is the list of fields you can add to retrieve information related to the listing. Fields are separated by commas, without spaces.

Name	Description
address	Returns the address object of the listing
tags	Returns tags associated with the listing
questions	Questions linked to the listing
faqs	FAQ for the listing
benefits	Benefits

Request example

Without fields

cURL request

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

With fields

cURL request

curl -X GET https://api.flatchr.io/vacancy/Wy3EOp2NP3p1KMq8?fields=address,tags

Response

Name	Type	Description
id	string	Unique job listing identifier
vacancy_id	integer	Listing ID
slug	string	URL slug of the listing
reference	string	Listing reference
title	string	Listing title
description	string	Listing description
experience	integer	Required experience (see experience)
mission	string	Job mission description
profile	string	Required profile for the position
salary	string	Offered salary
status	integer	Listing status
language	string	Listing language
contract_type_id	integer	Contract type ID
education_level_id	integer	Education level required ID
activity_id	integer	Activity ID (see activities)
channel_id	integer	Distribution channel ID (see channels)
metier_id	integer	Job category ID (see metiers)
company_id	integer	Company ID
mensuality	enum (y,m,d,h)	Salary payment frequency (year, month, day, hour)
apply_url	Null	URL to apply for the listing
currency	string	Salary currency
created_at	string	Listing creation date
updated_at	string	Listing last update date
start_date	Null	Contract start date
end_date	Null	Contract end date
driver_license	boolean	Whether a driving license is required
remote	enum	Remote work ("notime", "parttime", "fulltime")
handicap	boolean	Whether the position is open to people with disabilities
partial	boolean	Whether the position is part-time
meta_title	Null	SEO meta title
meta_description	Null	SEO meta description
meta_tags	Null	SEO meta tags
options	Object options	Listing options for display on career sites
kanban	boolean	Whether the listing uses Kanban
slug_mail	string	Email slug
address if present in fields	Object address	Full address information for the listing
tags if present in fields	Object tag	Tags

Response example

View example

{
    "id": "Wy3EOp2NP3p1KMq8",
    "vacancy_id": 1950,
    "slug": "v41qg9ejqvpk6xev-annonce",
    "reference": "TAP_test",
    "title": "Fullstack Developer",
    "description": "<p>XXXXXXX</p>",
    "experience": 2,
    "mission": "<p>XXXXX</p>",
    "salary": "0",
    "status": 1,
    "language": "fr_FR",
    "contract_type_id": 1,
    "education_level_id": 3,
    "activity_id": 16,
    "channel_id": 2,
    "metier_id": 44,
    "company_id": 59,
    "mensuality": "y",
    "apply_url": null,
    "currency": "EUR",
    "created_at": "2023-05-31T08:27:15.912Z",
    "updated_at": "2023-07-13T13:29:33.853Z",
    "start_date": null,
    "end_date": null,
    "driver_license": false,
    "remote": "partime",
    "handicap": false,
    "partial": false,
    "meta_title": null,
    "meta_description": null,
    "meta_tags": null,
    "options": {
      "required": ["email", "resume", "motivation"],
      "optionals": ["phone", "social_links"],
      "desactivated": ["indeed"],
      "motivationType": "text"
    },
    "kanban": true,
    "slug_mail": "vpjx6v",
    "tags": [
      {
        "id": "V41QG9ejLPpK6Xev",
        "tag_id": 2694,
        "company_id": 99,
        "title": "Tech",
        "values": "",
        "multiple": false,
        "creatable": false,
        "folder": false,
        "type": "vacancies",
        "position": 9
      }
    ]
}