Folk Flow’s Jobs API is a REST API based on simple HTTP POST giving a JSON response. Job boards may use this API to get active jobs from Folk Flow database to add them to their own database.
To use the API, you’ll need an API key. Write to us with details about your company and the planned usage at contact @ folkflow.com to request a key for yourself.
URL
https://api.folkflow.com/jobs.php
Parameters (POST)
| Parameter | Description | Allowed Values |
|---|---|---|
api_key | Your api key. Write to us with details about your company and the planned usage at contact @ folkflow.com to request a key for yourself. | NA |
employment_type | Type of employment offered by the jobs. | Full-time, Part-time, Freelance, Internship, Other |
fully_remote | To check whether work-from-home is allowed | 0 – not allowed; 1 – allowed |
industry | The industry to which the jobs belong. | Download the list of industry names allowed. Eg: Manufacturing |
function | The function to which the jobs belong. | Download the list of function names allowed. Eg: Marketing |
country | The id for country where the jobs need to be located. The country codes are as per ISO format. | Download the list of country ids. |
city | The id for city where the jobs need to be located. The city codes are as per ISO format. | Download the list of city ids. |
Response (Plain text)
| Response | Suggestion |
|---|---|
API key not found | Please check if you are sending the data using POST method. |
Invalid API key | Please check your API key. |
No active jobs found for your request | Change parameters you are using to get jobs. |
<Valid JSON string made up of jobs matching your request with details as given below> | The response is encoded in utf8. |
Valid requests will receive the following details of all the matching jobs:
| Detail | Explanation |
|---|---|
job_id | Unique id for each job |
title | Job title |
role_overview | Overview of the job role |
responsibilities | Responsibilities that the applicant will have when performing this job |
requirements | Skills required to perform the job |
benefits | Benefits provided by the company |
employment_type | Full-time, Part-time, Internship, Freelance, Other |
experience | Amount of prior-experience required. (Open ended field) |
education | Bachelors Degree, Masters Degree, Doctorate, High-School, Other. |
salary_currency | Currency in which salary numbers are provided. |
salary_from | Minimum salary offered for the role. |
salary_to | Maximum salary offered for the role. |
equity_from | Minimum equity offered for the role. |
equity_to | Maximum equity offered for the role. |
country | Country name |
city | City name |
fully_remote | 0 – not allowed; 1 – allowed |
industry | Industry name. Eg: Manufacturing |
function | Job function name. Eg: Marketing |
url_jd | Link to job description page |
url_apply | Link to application form |
url_co_logo | Link to company logo |
co_name | Company name |