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.

​
Overview

Hiring Team endpoints allow you to assign recruiters and hiring managers to specific job openings, enabling collaboration on candidate evaluation and pipeline management.

​
Get Hiring Team

curl -X GET http://localhost:8080/api/jobs/1/team
Retrieve all team members assigned to a specific job opening.

​
Path Parameters

​
jobId
integer
required
The unique identifier of the job

​
Response

{
  "data": [
    {
      "id": 1,
      "jobId": 1,
      "userId": 5,
      "addedAt": "2024-01-15T10:30:00Z",
      "user": {
        "id": 5,
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "jane.smith@company.com",
        "role": "recruiter",
        "avatarUrl": "https://r2.openats.com/avatars/jane.png"
      }
    },
    {
      "id": 2,
      "jobId": 1,
      "userId": 12,
      "addedAt": "2024-01-15T11:00:00Z",
      "user": {
        "id": 12,
        "firstName": "Bob",
        "lastName": "Johnson",
        "email": "bob@company.com",
        "role": "hiring_manager",
        "avatarUrl": null
      }
    }
  ]
}

​
Add Team Member

curl -X POST http://localhost:8080/api/jobs/1/team \
  -H "Content-Type: application/json" \
  -d '{
    "userId": 5
  }'
Assign a user to the hiring team for a specific job opening.

​
Path Parameters

​
jobId
integer
required
The unique identifier of the job

​
Body Parameters

​
userId
integer
required
The unique identifier of the user to add to the hiring team

​
Response

{
  "data": {
    "id": 3,
    "jobId": 1,
    "userId": 5,
    "addedAt": "2024-01-20T14:30:00Z"
  }
}

​
Error Responses

​
409 Conflict
Returned when the user is already a member of the hiring team
​
400 Bad Request
User not found
​
404 Not Found
Job not found

​
Remove Team Member

curl -X DELETE http://localhost:8080/api/jobs/1/team/5
Remove a user from the hiring team. The job creator cannot be removed from their own job’s team.

​
Path Parameters

​
jobId
integer
required
The unique identifier of the job
​
userId
integer
required
The unique identifier of the user to remove from the hiring team

​
Response

{
  "data": {
    "id": 3,
    "jobId": 1,
    "userId": 5,
    "addedAt": "2024-01-20T14:30:00Z"
  }
}

​
Error Responses

​
403 Forbidden
Cannot remove the job creator from the hiring team
​
404 Not Found
User is not on this job’s hiring team, or job not found

Build docs developers (and LLMs) love

Get started for freeTalk to us