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.

​
Welcome to the OpenATS API

The OpenATS API is a comprehensive RESTful API that powers the OpenATS Applicant Tracking System. It handles everything from job creation and candidate management to technical assessments and offer generation.

​
Base URL

All API requests should be made to: 
http://localhost:8080/api
The base URL above is for local development. In production, replace localhost:8080 with your deployed API server address.

​
API Version

The current API version is 1.0.0.

​
Request Format

All requests to the API should:
  • Use HTTPS in production (HTTP for local development)
  • Include the Content-Type: application/json header for POST/PUT requests
  • Send request bodies in JSON format

​
Example Request

curl -X GET http://localhost:8080/api/company \
  -H "Content-Type: application/json"

​
Response Format

The API returns responses in JSON format. Successful responses typically include a data field containing the requested information.

​
Success Response

{
  "data": {
    "id": 1,
    "name": "Acme Corp",
    "website": "https://acme.com",
    "logoUrl": "https://r2.openats.com/logos/acme.png"
  }
}

​
HTTP Status Codes

The API uses standard HTTP status codes:
Status CodeDescription
200Success - Request completed successfully
201Created - Resource created successfully
400Bad Request - Invalid request parameters
401Unauthorized - Authentication required
404Not Found - Resource doesn’t exist
500Internal Server Error - Something went wrong on the server

​
Error Handling

When an error occurs, the API returns an error response with an appropriate HTTP status code and error message.

​
Error Response Format

{
  "error": "Internal server error"
}

​
Example Error Response

curl -X GET http://localhost:8080/api/invalid-endpoint
Response: 
{
  "error": "Internal server error"
}

​
API Features

The OpenATS API is organized into the following categories:

Company

Manage company profile, branding, and departments

Users

Handle team members, roles, and profiles

Jobs

Create and manage job postings

Candidates

Track candidate applications and pipeline movement

Assessments

Create technical tests and questions

Templates

Design reusable email and document templates

​
Health Check

You can verify the API is running by calling the health endpoint: 
curl http://localhost:8080/health
Response: 
{
  "status": "working"
}

​
Interactive API Documentation

OpenATS also provides interactive API documentation using Swagger UI. When running the API server locally, visit: 
http://localhost:8080/api-docs
This interface allows you to explore all endpoints, view request/response schemas, and test API calls directly from your browser.

​
Next Steps

Authentication

Learn how to authenticate your API requests

Core Endpoints

Start making API calls to core endpoints

Build docs developers (and LLMs) love

Get started for freeTalk to us