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 Users

GET /users
Retrieve a list of all active recruitment team members.

​
Response

​
data
array
Array of user objects

​
Example Request

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

​
Error Codes

​
500
error
Failed to fetch users

​
Get User Profile

GET /users/{id}
Retrieve detailed information for a specific user.

​
Path Parameters

​
id
integer
required
User ID

​
Response

​
data
object
User profile object

​
Example Request

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

​
Error Codes

​
400
error
Invalid user ID
​
404
error
User not found
​
500
error
Failed to fetch user

​
Update User Profile

PUT /users/{id}
Update an existing user’s profile information.

​
Path Parameters

​
id
integer
required
User ID to update

​
Request Body

​
firstName
string
User’s first name (1-100 characters)
​
lastName
string
User’s last name (1-100 characters)
​
role
string
User role: super_admin, hiring_manager, or interviewer
​
avatarUrl
string
Valid URL to user’s avatar image (max 1000 characters)

​
Response

​
data
object
Updated user profile object

​
Example Request

curl -X PUT http://localhost:8080/api/users/1 \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "role": "hiring_manager",
    "avatarUrl": "https://example.com/avatars/johndoe.jpg"
  }'

​
Error Codes

​
400
error
Invalid user ID OR Validation failed
​
404
error
User not found
​
500
error
Failed to update user

Build docs developers (and LLMs) love

Get started for freeTalk to us