Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/chamals3n4/OpenATS/llms.txt

Use this file to discover all available pages before exploring further.

​
List All Job Openings

GET /jobs
Returns all jobs with basic details.

​
Response

​
data
array
Array of job objects

​
Example Request

curl -X GET http://localhost:8080/api/jobs

​
Error Codes

​
500
error
Failed to fetch jobs

​
Create Job Opening

POST /jobs
Create a new job opening in the system.

​
Request Body

​
title
string
required
Job title (1-255 characters)
​
departmentId
integer
required
Department ID this job belongs to
​
employmentType
string
required
Employment type: full_time, part_time, contract, internship, or freelance
​
location
string
Job location (max 255 characters)
​
description
string
Detailed job description
​
skills
array
Array of required skills (each 1-100 characters)
​
salaryType
string
Salary structure: fixed or range
​
currency
string
3-letter ISO currency code (e.g., USD)
​
payFrequency
string
Pay frequency: hourly, daily, weekly, monthly, or yearly
​
salaryMin
number
Minimum salary (required if salaryType is range)
​
salaryMax
number
Maximum salary (required if salaryType is range)
​
salaryFixed
number
Fixed salary amount (required if salaryType is fixed)
​
createdBy
integer
User ID of creator (defaults to 1)

​
Response

​
data
object
Created job object

​
Example Request

curl -X POST http://localhost:8080/api/jobs \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Senior Backend Engineer",
    "departmentId": 1,
    "employmentType": "full_time",
    "location": "San Francisco, CA (Remote)",
    "description": "We are looking for...",
    "skills": ["Node.js", "PostgreSQL", "Drizzle"],
    "salaryType": "range",
    "currency": "USD",
    "payFrequency": "yearly",
    "salaryMin": 120000,
    "salaryMax": 180000
  }'

​
Error Codes

​
400
error
Validation failed OR Department not found OR Invalid salary configuration
​
500
error
Failed to create job

​
Get Job Details

GET /jobs/{id}
Retrieve full details for a specific job opening.

​
Path Parameters

​
id
integer
required
Job ID

​
Response

​
data
object
Complete job object with all fields

​
Example Request

curl -X GET http://localhost:8080/api/jobs/1

​
Error Codes

​
400
error
Invalid job ID
​
404
error
Job not found
​
500
error
Failed to fetch job

​
Get Job by Slug

GET /jobs/slug/{slug}
Public endpoint to fetch job information by its URL slug. Used by careers pages.

​
Path Parameters

​
slug
string
required
URL-friendly job slug

​
Response

​
data
object
Public job details

​
Example Request

curl -X GET http://localhost:8080/api/jobs/slug/senior-backend-engineer

​
Error Codes

​
400
error
Invalid job slug
​
404
error
Job not found
​
500
error
Failed to fetch job

​
Update Job

PUT /jobs/{id}
Update an existing job’s details.

​
Path Parameters

​
id
integer
required
Job ID to update

​
Request Body

All fields are optional. Only include fields you want to update.
​
title
string
Job title (1-255 characters)
​
departmentId
integer
Department ID
​
status
string
Job status: draft, inactive, published, closed, or archived
​
employmentType
string
Employment type: full_time, part_time, contract, internship, or freelance
​
location
string
Job location (max 255 characters)
​
description
string
Job description
​
skills
array
Array of required skills
​
salaryType
string
Salary structure: fixed or range
​
currency
string
3-letter currency code
​
payFrequency
string
Pay frequency: hourly, daily, weekly, monthly, or yearly
​
salaryMin
number
Minimum salary
​
salaryMax
number
Maximum salary
​
salaryFixed
number
Fixed salary amount

​
Response

​
data
object
Updated job object

​
Example Request

curl -X PUT http://localhost:8080/api/jobs/1 \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Lead Backend Engineer",
    "status": "published",
    "salaryMax": 200000
  }'

​
Error Codes

​
400
error
Invalid job ID OR Validation failed OR Department not found
​
404
error
Job not found
​
500
error
Failed to update job

​
Delete Job

DELETE /jobs/{id}
Permanently delete a job opening.

​
Path Parameters

​
id
integer
required
Job ID to delete

​
Response

​
data
object
Deleted job object

​
Example Request

curl -X DELETE http://localhost:8080/api/jobs/1

​
Error Codes

​
400
error
Invalid job ID
​
404
error
Job not found
​
409
error
Cannot delete a job that has candidates. Close or archive it instead.
​
500
error
Failed to delete job

Build docs developers (and LLMs) love

Get started for freeTalk to us