Reserve Bench

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Note: This is a legacy endpoint. For new integrations, please use the Add Draft Employee mutation instead.

Add Applicant to Reserve Bench

Add an applicant to the reserve bench. The reserve bench is used to store potential candidates who can later be invited to become employees by a manager.

REST Endpoint:

POST https://staging.roubler.net/api/applicants

Request Body Parameters:

Parameter	Type	Required	Description
`application.firstName`	`String`	Yes	Applicant's first name
`application.lastName`	`String`	Yes	Applicant's last name
`application.emailAddress`	`String`	Yes	Applicant's email address
`application.position`	`String`	No	Position name the applicant is applying for
`application.assignedUser`	`String`	No	Name of the user to assign this applicant to
`application.location`	`String`	No	Location name where the applicant would work
`application.employmentStatus`	`String`	No	Employment status (e.g., "Full Time", "Part Time")

Response Fields:

Field	Description
`api`	API version information
`time`	Timestamp of the request
`data.id.id`	Unique identifier for the created applicant

Implementation Notes:

This is a REST API endpoint (not GraphQL) for adding applicants to the reserve bench
Only firstName, lastName, and emailAddress are required fields
The optional fields (position, assignedUser, location, employmentStatus) help organize and assign applicants
Once added to the reserve bench, a manager can create an employee invite for the applicant
The email address must be unique and not already associated with an existing employee
Position and location names should match existing positions and locations in the system

REST API Request

POST https://staging.roubler.net/api/applicants
Content-Type: application/json
Authorization: Bearer <access_token>
X-Company-ID: <company_id>

Request Body:

{
  "application": {
    "firstName": "Jamie",
    "lastName": "Applicant",
    "emailAddress": "jamie.applicant@example.com",
    "position": "Full Stack Developer",
    "assignedUser": "Craig Bussell",
    "location": "Integration Sandbox",
    "employmentStatus": "Full Time"
  }
}

Example Response

{
  "api": "RoublerAPI v5.0.0",
  "time": "2024-06-05T03:33:22+00:00",
  "data": {
    "id": {
      "id": "94"
    }
  }
}