Skip to main content

​
List all jobs

Retrieve a list of all job postings in the FairMatch AI system.

​
Endpoint

GET /api/jobs

​
Authentication

This endpoint requires authentication. Include your authentication credentials in the request.

​
Query parameters

This endpoint does not accept any query parameters.

​
Response

Returns an array of job objects.
​
id
string
Unique identifier for the job.
​
company_id
string
The ID of the company that posted this job.
​
title
string
The job title.
​
required_skills
array
List of required skills for this position.
​
preferred_skills
array
List of preferred skills for this position.
​
min_experience
integer
Minimum years of experience required.
​
openings
integer
Number of open positions.
​
weight_skill
integer
Weight for skill evaluation in candidate scoring.
​
weight_github
integer
Weight for GitHub evaluation in candidate scoring.
​
weight_interview
integer
Weight for interview evaluation in candidate scoring.
​
weight_experience
integer
Weight for experience evaluation in candidate scoring.
​
weight_integrity
integer
Weight for integrity evaluation in candidate scoring.

​
Status codes

​
200
Success
Jobs retrieved successfully.
​
401
Unauthorized
Authentication credentials are missing or invalid.
​
500
Internal Server Error
An error occurred while retrieving jobs.

​
Example request

curl -X GET https://api.fairmatch.ai/api/jobs \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example response

[
  {
    "id": "a1b2c3d4",
    "company_id": "comp_123",
    "title": "Senior Full Stack Engineer",
    "required_skills": ["Python", "React", "PostgreSQL"],
    "preferred_skills": ["Docker", "AWS", "TypeScript"],
    "min_experience": 3,
    "openings": 5,
    "weight_skill": 30,
    "weight_github": 25,
    "weight_interview": 25,
    "weight_experience": 10,
    "weight_integrity": 10
  },
  {
    "id": "e5f6g7h8",
    "company_id": "comp_456",
    "title": "Backend Engineer",
    "required_skills": ["Python", "FastAPI", "PostgreSQL"],
    "preferred_skills": ["Redis", "Kubernetes"],
    "min_experience": 2,
    "openings": 3,
    "weight_skill": 35,
    "weight_github": 20,
    "weight_interview": 20,
    "weight_experience": 15,
    "weight_integrity": 10
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us