logo
API docs by Redocly

WorkLLama-Platform-API (2)

Download OpenAPI specification:Download

Krishna J Vedula: krishna@workllama.com URL: https://www.workllama.com

Build, Nurture & Grow with a Talent Community Platform

The exclusive WorkLLama Talent Community Platform is a holistic SaaS solution that empowers you 
at every stage of the talent pipeline to attract, engage, hire and grow superior talent.

Build

WorkLLama makes it easy to engage the talent already in your ATS and perpetually attract qualified candidates into your pipeline.

Automate marketing and outreach to welcome candidates into your talent community.
Extend your direct sourcing channels 10x with social referral management.
Personalize engagement with our AI conversational bot without losing time — or that personal touch.

Nurture

WorkLLama helps you deeply understand your talent pool and keep your employer brand top-of-mind with purposeful & friction-free candidate engagement.

Engage candidates on preferred devices with two-way,
omni-channel messaging that carries your brand.
Gain feedback and build trust through surveys and polls that help candidates feel seen and heard.
Cut manual work and copy-paste emails. Let your AI conversational bot drive candidate actions.

Grow

WorkLLama helps you retain experienced and high-performing employees while making sure you have the data to make well-informed workforce decisions.

Push job notifications, manage shifts and get instant responses for workforce needs through your branded app.
Know worker availability, career goals & income objectives with profiles that are easy to search, update and maintain.
See your best referral sources, know your open rates and track your campaigns with analytics that show you the way.

WorkLLama Platform API for managing*

- Job Postings or Job Orders, 
- Candidates and 
- Job Assignments (matching a Job Posting with a Candidate).
- Talent Pools (Collections of candidates based on specific criteria or static list)

Authentication

Authentication related Endpoints, that support Javascript Web Tokens (JWT)

/v2/auth/login

Authorizations:
JWTAuth
Request Body schema: application/json
required
companyCode
string
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "companyCode": "xxx",
  • "username": "admin@mailinator.com",
  • "password": "wl@2020"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

/v2/auth/refresh

Authorizations:
JWTAuth
Request Body schema: application/json
required
token
string

Responses

Request samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJtdnBhZG1pbkBtYWlsaW5hdG9yLmNvbSIsInNjb3BlcyI6WyJST0xFX1JFRlJFU0hfVE9LRU4iXSwidXNlcklkIjozMTc5MzQsImxvY2FsZSI6ImVuLVVzIiwiY29tcGFueUlkIjoxMDU2OSwiaXNzIjoiaHR0cDovL3d3dy53b3JrbGxhbWEuY29tIiwianRpIjoiYjI0NzU1MDEtZWU1Zi00OTA1LThkMTEtMjQ5ZDdmMGI1Yjc4IiwiaWF0IjoxNjUyOTM3MzkwLCJleHAiOjE2NTQxNDY5OTB9.nfNrkWaOUZKcXqVvqNQ8fn4UvCea00uUm6hW5ZgOookHMMvN6IpYgI7wbHQqpLCbjVKOQv_GlksQ-2e8dhSlGQ"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Candidate

Endpoints related to Candidate Management

Get the Details of the Candidate with a specified Id

Get the Details of the Candidate with a specified Id

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
header Parameters
Authentication
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Create/update the Candidate

This POST operation creates/updates the Candidate. If a Canidate is found with id or externalRef, then the Candidate is updated. If a Candidate is not found with id or externalRef, then a new Candidate is created.

Authorizations:
JWTAuth
header Parameters
Authentication
any

JWT Authentication

Request Body schema: application/json
required
id
integer
externalRef
string
status
string
employeeType
string
firstName
required
string
lastName
required
string
middleName
string
preferredName
string
address1
string
address2
string
city
string
state
string
postalCode
string
country
string
email
required
string
email1
string
email2
string
phoneNumber
string
mobilePhone1
string
mobilePhone2
string
workPhone1
string
workPhone2
string
homePhone1
string
homePhone2
string
registrationDate
string <date>
activeAssignmentCompanyId
integer
activeAssignmentStatus
string
lastTitle
string
availabilityStatus
string
comments
string
description
string
willingToRelocate
string
race
string
gender
string
ethinicity
string
dateOfBirth
string <date>
parsedSkills
string
tags
Array of strings
skills
Array of strings
object (Root Type for Contact)
object (Root Type for Contact)
object (Root Type for CustomData)
language
string

Candidate's preffered language

shiftPreference
Array of strings

Shift preference refers to a candidate preference for a specific work shift. Its a comma separated values if candidates wishes to choose more than one shift.

remotePreference
string

remotePreference

object (Root Type for MonetaryUOM)
preferredWorkerType
string

preferredWorkerType

workEmail
string

workEmail

Array of objects (DesiredLocation)

desiredLocation

Array of objects (SocialNetwork)

socialProfile

Responses

Request samples

Content type
application/json
Example
{
  • "firstName": "some text",
  • "lastName": "some text",
  • "defaultCompany": "some text",
  • "email": "some text",
  • "phoneNumber": "some text"
}

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "data": {
    }
}

Get all candidates ids created or updated in a given date range

Get all candidates ids which are created or updated in a given date range.

Authorizations:
JWTAuth
query Parameters
pageNumber
integer
Default: 1
Examples:
  • pageNumber=1 -

default page number is set to 1

pageSize
integer
Default: 5
Examples:
  • pageSize=5 -

default page size is set to 5

fromDate
required
string <date-time>
Examples:
  • fromDate=2024-02-19 -
  • fromDate=1704047400 -

Date value formats supported are:

  • The most common ISO Date Format yyyy-MM-dd, example: 2024-01-31
  • The Epoch second, example 1704047400
toDate
required
string <date-time>
Examples:
  • toDate=2024-02-25 -
  • toDate=1704047400 -

Date value formats supported are:

  • The most common ISO Date Format yyyy-MM-dd, example: 2024-01-31
  • The Epoch second, example 1704047400
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}

Search candidates

Authorizations:
JWTAuth
header Parameters
Authentication
any

JWT Authentication

Request Body schema: application/json
required

Supported filters to search candidate:

id, externalRef, registrationType, employeeType, userType, authStatus, enabled, firstName, lastName, middleName, preferredName, address1, address2, city, state, postalCode, country, email, email1, emailVerified, userName, phoneNumber, phoneNumberVerified, mobilePhone1, workPhone1, homePhone1, sourceType, originType, gender, status, desiredLocation.city, desiredLocation.state, desiredLocation.country, desiredLocation.zipcode, willingToRelocate, shiftPreference, remotePreference, preferredWorkerType, "Security Clearance", desiredPay, socialProfileName

companyCode
string
Array of objects (Root Type for JobFilter)
Array of objects (Root Type for SortCriteria)
pageSize
integer <int32>
pageNumber
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "companyCode": "SNDBX2UAT",
  • "filters": [
    ],
  • "sort": [
    ],
  • "pageSize": 100,
  • "pageNumber": 1
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}

CandidateDocument

Documents related to a Candidate (Skills, Certifications, Timesheets etc)

Get document list for the given candidate with candidateId

Returns the requested page of Documents for the given candidate with candidateId

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageNumber
integer
pageSize
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Creates/updates the Candidate's Document.

This POST operation creates/updates the Candidate's Document. If a Document is found for the Candidate is found with id or externalRef, then the Candidate's Document is updated. If a Document is not found with id or externalRef of Document, then a new Document is creted for the Candidate.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: multipart/form-data
required

Attach documents to the given candidate

id
string
name
string
file
required
string <binary>
externalRef
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Get a document for given candidate id and document id

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
documentId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

CandidateEducation

Education History for a Candidate

Get Education History for the given candidate with candidateId

Returns the requested page of Education History for the given candidate with candidateId

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageNumber
integer
pageSize
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Creates/updates the Candidate's Education History.

This POST operation creates/updates the Candidate's Education History. If a Education History is found for the Candidate is found with id or externalRef, then the Candidate's Education History is updated. If a Education History is not found with id or externalRef of Education History, then a new Education History is creted for the Candidate.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required

Education History of the candidate

Array
id
integer <int32>
externalRef
string
qualification
string
institute
string
country
string
grade
string
startDate
string <date>
completionDate
string <date>
major
string
minor
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Deletes Education History records for a specified Candidate id and EducationHistory id

Deletes Education History records for a specified Candidate id

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
educationHistoryId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": "Successfully deleted Education History records for the Candidate"
}

CandidateJobHistory

Job History related to a Candidate

Get Job History for the given candidate with candidateId

Returns the requested page of Job History for the given candidate with candidateId

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
Examples:
  • 1034867 -
query Parameters
pageNumber
integer
Examples:
  • pageNumber=1 -

Default page number is 1.

pageSize
integer
Examples:
  • pageSize=10 -

Default page size is 5. If given page size is less than 5 (Eg. 3) then value 5 will be taken for page size

header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}

Creates/updates the Candidate's Job History.

This POST operation creates/updates the Candidate's Job History. If a Job History is found for the Candidate is found with id or externalRef, then the Candidate's Job History is updated. If a Job History is not found with id or externalRef of Job History, then a new Job History is creted for the Candidate.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
Examples:
  • 1034867 -
header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required

Job History of the candidate

Array
id
integer <int32>
externalRef
string
company
string
location
string
title
string
startDate
string <date>
endDate
string <date>
customText1
string
customText2
string
customText3
string
customText4
string
customText5
string
customText6
string
customText7
string
customText8
string
customText9
string
customText10
string

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Deletes a Job History record for a specified Candidate id and JobHistory id

Deletes a Job History record for a specified

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
Examples:
  • 1034867 -
jobHistoryId
required
integer
Examples:
  • 1034867 -
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": "Job History record deleted successfully for candidate"
}

CandidateNotes

Notes for a Candidate

Add notes to candidate

The notes/comments added by Hiring Manager for Candidates as multiple notes are shared with candidates at different stages

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer

Candidate Id

header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required
comment
required
string
recruiterId
required
integer

its a recruiterId

Responses

Request samples

Content type
application/json
{
  • "comment": "pj",
  • "recruiterId": 20
}

Response samples

Content type
application/json
[
  • {
    }
]

CandidateReference

Professional References related to a Candidate

Get Professional References for the given candidate with candidateId

Returns the requested page of Professional References for the given candidate with candidateId

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageNumber
required
integer
pageSize
required
integer
header Parameters
Authentication
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Creates/updates the Candidate's Professional Reference.

This POST operation creates/updates the Candidate's Professional Reference. If a Professional Reference is found for the Candidate is found with id or externalRef, then the Candidate's Professional Reference is updated. If a Professional Reference is not found with id or externalRef of Professional Reference, then a new Professional Reference is creted for the Candidate.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageSize
integer
pageNumber
integer
header Parameters
Authentication
any

JWT Authentication

Request Body schema: application/json
required
Array
id
integer <int32>
externalRef
string
name
string
company
string
title
string
email
string
phoneNumber
string
permissionToContact
boolean
customText1
string
customText2
string
customText3
string
customText4
string
customText5
string
customText6
string
customText7
string
customText8
string
customText9
string
customText10
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Deletes Professional Reference for a specified Candidate id and Professional Reference id

Deletes Professional Reference for a specified Candidate id

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageSize
integer
pageNumber
integer
referenceId
required
integer
header Parameters
Authentication
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": "Successfully deleted the Candidates from TalentPool"
}

CandidateResume

Resumes related to a Candidate

Get Resumes for the given candidate with candidateId

Returns the requested page of Resumes for the given candidate with candidateId

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageNumber
integer
pageSize
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Creates/updates the Candidate's resume.

This POST operation creates/updates the Candidate's resume. If a resume is found for the Candidate is found with id or externalRef, then the Candidate's resume is updated. If a resume is not found with id or externalRef of resume , then a new resume is creted for the Candidate.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": "Successfully deleted the Candidates from TalentPool"
}

Get active or default Resume for the given Candidate with candidateId

Returns the active or default Resume for the given Candidate with candidateId

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
header Parameters
Authentication
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": {
    }
}

Get a resume for given candidate id and resume id

Returns the resumeId content of given candidate Id.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
resumeId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CandidateSkill

Skills related to a Candidate

Get associated skills for the given candidate

Returns the requested page of skills associated to the given candidate.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageNumber
integer
pageSize
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add skill to the candidate.

This POST operation creates/updates the Candidate's Skills. If a Skill is found for the Candidate is found with id, then the Candidate's Skill is updated. If a Skill is not found with id of Skill , then a new Skill is creted for the Candidate.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required

Skill for the Candidate

Array
skillName
required
string

Name of the skill

Responses

Request samples

Content type
application/json
[
  • [
    ]
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a Skill for a specified Candidate and skill id

Deletes a Skill for a specified Candidate and skill id.

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
skillName
required
string
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": "Successfully deleted the Skill for the Candidate"
}

Company

Endpoints related to Company management

Get company details based on the company id

Authorizations:
JWTAuth
path Parameters
companyId
required
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

JobApplication

Job Application for Candidate against a Job

Get the List of the Job Applications for the Specified Job

Get the List of the Job Applications for the Specified Job

Authorizations:
JWTAuth
path Parameters
jobPostingId
required
integer

The id of the Job being applied to.

query Parameters
pageNumber
integer
pageSize
integer
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the List of the Job Applications for the Specified Candidate

Get the List of the Job Applications for the Specified Candidate

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
query Parameters
pageNumber
integer
pageSize
integer
header Parameters
Authentication
required
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Submit a Candidate to Job Posting

Submit a Candidate to Job Posting

Authorizations:
JWTAuth
path Parameters
candidateId
required
integer
header Parameters
Authentication
required
any
Request Body schema: application/json
required

This POST operation creates/updates the Job Application(s) in the WL DB. If a Job Application is found for the given job application id, then Job Application is updated. If there is no Job Application Id, then a new Job Application is creted for the Candidate.
Note: only supported job application statues are PROSPECT and APPLIED.

id
integer <int32>

Job Application Id

externalRef
string
jobPostingId
required
integer <int32>

The id of the Job being applied to.

applicationDate
string
status
string
Enum: "INITIATED" "PROSPECT" "APPLIED" "SCREENING" "SHORTLISTED" "EXTERNAL_SEND_OUT" "INTERVIEW" "REVIEW" "ABANDONED" "REJECTED" "BACKGROUND_CHECK" "OFFERED" "ACCEPTED" "REFUSED" "REVOKED" "HIRED" "TERMINATED" "STANDBY"

job application status. Note: default job application status is PROSPECT.

reason
string
comment
string
offeredDate
string
acceptedDate
string
rejectedDate
string
hiredDate
string
plannedStartDate
string
actualStartDate
string
plannedEndDate
string
actualEndDate
string
offeredPayRate
string
billRate
string

Bill Rate of the applicant

object (Root Type for CustomData)
workllamaInterfaceId
string

Unique ID incremented for the Company, Entity (Job, Candidate, Placement, Job Application)

workllamaUuid
string

Unique ID across all companies.

source
string

please provide Job Application Source.

Responses

Request samples

Content type
application/json
{
  • "jobPostingId": 32
}

Response samples

Content type
application/json
[
  • {
    }
]

JobPlacement

Job Placement involves the task of transitioning job applicants into employees within a company

Get placement details based on the placement id

Authorizations:
JWTAuth
path Parameters
placementId
required
integer
query Parameters
fetch_custom_data
boolean

If parameter value for fetch_custom_data is true then placement custom data will be included in the response.

header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Get all placement ids created or updated in a given date range

Get all placement ids which are created or updated in a given date range.

Authorizations:
JWTAuth
query Parameters
pageNumber
integer
Examples:
  • pageNumber=1 -

default page number is set to 1

pageSize
integer
Examples:
  • pageSize=5 -

default page size is set to 5

fromDate
required
string <date-time>
Examples:
  • fromDate=2024-02-19 -
  • fromDate=1704047400 -

Date value formats supported are:

  • The most common ISO Date Format yyyy-MM-dd, example: 2024-01-31
  • The Epoch second, example 1704047400
toDate
required
string <date-time>
Examples:
  • toDate=2024-02-25 -
  • toDate=1704047400 -

Date value formats supported are:

  • The most common ISO Date Format yyyy-MM-dd, example: 2024-01-31
  • The Epoch second, example 1704047400
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}

JobPosting

Job Posting Related Paths

Get all job posting ids created or updated in a given date range

Get all job posting ids created or updated in a given date range

Authorizations:
JWTAuth
query Parameters
pageNumber
integer

default page number is set to 1

fromDate
required
string <date-time>

Date value formats supported are:

  • The most common ISO Date Format yyyy-MM-dd, example: 2024-01-31
  • The Epoch second, example 1704047400
pageSize
integer

default page size is set to 5

toDate
required
string <date-time>

Date value formats supported are:

  • The most common ISO Date Format yyyy-MM-dd, example: 2024-01-31
  • The Epoch second, example 1704047400
header Parameters
Authentication
required
any
Examples:
  • Bearer xxx.xxx.xx -

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}

Search job postings

Authorizations:
JWTAuth
header Parameters
Authentication
required
any
Examples:
  • Bearer xxx.xxx.xx -

JWT Authentication

Request Body schema: application/json
required

Supported filter keys to search Jobs:

title, id, externalRef, description, status, numberOfPositions, startImmediately, payRateHigh, payRateLow, billRateHigh, billRateLow, payRateNegotiable, source, categories, tags, employmentType, shifts, remoteType

companyCode
string
Array of objects (Root Type for JobFilter)
Array of objects (Root Type for SortCriteria)
pageSize
integer <int32>
pageNumber
integer <int32>

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "YUPROUAT",
  • "filters": [
    ],
  • "pageNumber": 1,
  • "pageSize": 5,
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get the details of the Job Posting with a specified Id

Get the details of the Job Posting with a specified Id

Authorizations:
JWTAuth
path Parameters
jobPostingId
required
string
header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

This POST operation creates/updates the JobPosting

This POST operation creates/updates the JobPosting. If a JobPosting is found with id or externalRef, then the Job Posting is updated.

Authorizations:
JWTAuth
header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required
title
required
string
id
number
externalRef
string
description
required
string
status
required
string
Enum: "JOBPOSTING_STATUS_DRAFT" "JOBPOSTING_STATUS_UNPUBLISHED" "JOBPOSTING_STATUS_PUBLISHED" "JOBPOSTING_STATUS_CLOSED" "JOBPOSTING_STATUS_CANCELLED" "JOBPOSTING_STATUS_IN_REVIEW" "JOBPOSTING_STATUS_ON_HOLD" "JOBPOSTING_STATUS_OPEN" "JOBPOSTING_STATUS_FILLED"
datePosted
string <date>
startDate
string <date>
endDate
string <date>
numberOfPositions
number
startImmediately
boolean
payRateNegotiable
boolean
validThrough
string <date>
employmentType
string
Enum: "FULLTIME_EMPLOYEE_TYPE" "FLEX_EMPLOYEE_TYPE" "SEASONAL_EMPLOYEE_TYPE"
required
object (Root Type for Organization)

Either code (Company code) or id (Company id) needs to be passed.

skills
Array of strings
Array of objects (Root Type for TimeSlot)
remoteType
string
partTime
boolean
required
object (Facility)

Either id (Facility ID) or the state and country fields together are mandatory parameters.

object (JobPostingCustomData)
object (Root Type for Contact)
object (Root Type for Contact)
object (Root Type for Contact)
object (Root Type for Contact)
isRemoteType
boolean
object (Root Type for MonetaryUOM)
object (Root Type for MonetaryUOM)
object (Root Type for Contact)
object (Root Type for Contact)
partTimeOrFullTime
string

Part time or Full time job.

object (Root Type for Contact)
object (Facility)

Either id (Facility ID) or the state and country fields together are mandatory parameters.

object (Root Type for Contact)
jobType
string

Job type

object (BillingProfile)

Responses

Request samples

Content type
application/json
Example
{
  • "title": "Test QA Software Engineer",
  • "datePosted": "2023-11-18",
  • "validThrough": "2024-03-18T00:00",
  • "description": "test description",
  • "employmentType": "FULLTIME_EMPLOYEE_TYPE",
  • "hiringOrganization": {
    },
  • "location": {
    },
  • "payRate": {
    },
  • "billRate": {
    },
  • "skills": [
    ],
  • "status": "JOBPOSTING_STATUS_DRAFT"
}

Response samples

Content type
application/json
"{\n \"data\": {\n \"title\": \"Test QA Software Engineer\",\n \"id\": 277925,\n \"description\": \"test description\",\n \"status\": \"JOBPOSTING_STATUS_DRAFT\",\n \"datePosted\": \"2023-11-17\",\n \"startImmediately\": false,\n \"billRate\": {\n \"currency\": \"USD\",\n \"currencySymbol\": \"$\",\n \"unitOfMeasure\": \"UOM_DAY\",\n \"highValue\": 40,\n \"lowValue\": 40\n },\n \"payRate\": {\n \"currency\": \"USD\",\n \"currencySymbol\": \"$\",\n \"unitOfMeasure\": \"UOM_HOUR\",\n \"highValue\": 40,\n \"lowValue\": 40\n }\n \"payRateNegotiable\": false,\n \"categories\": [\n null\n ],\n \"validThrough\": \"2024-03-18\",\n \"employmentType\": \"FULLTIME_EMPLOYEE_TYPE\",\n \"hiringOrganization\": {\n \"code\": \"SNDBX2UAT\",\n \"id\": 13835,\n \"name\": \"Sandbox 2\",\n \"description\": \"\"\n },\n \"skills\": [],\n \"shifts\": [\n {}\n ],\n \"location\": {\n \"name\": \"Orlando, Florida\",\n \"streetAddress1\": \"601 East Rollins St\",\n \"streetAddress2\": \"\",\n \"locality\": \"Orlando\",\n \"postalCode\": \"32803\",\n \"country\": \"US\",\n \"state\": \"FL\",\n \"id\": 41235\n },\n \"customData\": {}\n }\n}"

TalentPool

Talent Pools of Candidates

Create/Update a Talent Pool

Create/Update a Talent Pool

Authorizations:
JWTAuth
header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required
talentPoolId
integer

Id of the Talent Pool

talentPoolName
required
string

Name of the Talent Pool

externalRef
string

External Reference Number

isPrivate
boolean

if isPrivate is true then recruiteId is mandatory. Otherwise it is an optional.

recruiterId
integer

it is a recruiterId

Responses

Request samples

Content type
application/json
Example
{
  • "talentPoolName": "sample-public-talent-pool"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the Details of the Talent Pool with a specified Id

Get the Details of the Talent Pool with a specified Id

Authorizations:
JWTAuth
path Parameters
talentPoolId
required
integer

WorkLLama talent pool id

header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a List of Talent Pools.

Gets a List of Talent Pools.

Authorizations:
JWTAuth
query Parameters
pageNumber
integer

default page number is set to 1

pageSize
integer

default page size is set to 5

recruiterId
integer

its an optional. if it is not present then it returns the public talent pools.otherwise it returns the public, private and shared talents pools.

header Parameters
Authentication
required
any

JWT Authentication Token

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}

Gets a List of Candidates for the Talent Pool

Gets a List of Candidates for the Talent Pool

Authorizations:
JWTAuth
path Parameters
talentPoolId
required
integer

WorkLLama talent pool id

query Parameters
pageNumber
integer

default page number is set to 1

pageSize
integer

default page size is set to 5

header Parameters
Authentication
required
any

JWT Authentication

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}

Add Candidate(s) to a Talent Pool. Works only for Manual Talent Pools.

Add Candidate(s) to a Talent Pool. Works only for Manual Talent Pools.

Authorizations:
JWTAuth
path Parameters
talentPoolId
required
integer

WorkLLama talent pool id

header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required

List of candidate ids to be added to the given Talent Pool

Array
integer

Responses

Request samples

Content type
application/json
[
  • 123421,
  • 123421
]

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Delete a list of Candidates from TalentPool

Delete a list of Candidates from TalentPool

Authorizations:
JWTAuth
path Parameters
talentPoolId
required
integer

WorkLLama talent pool id

header Parameters
Authentication
required
any

JWT Authentication

Request Body schema: application/json
required

List of candidate ids to be deleted from the given Talent Pool

Array
integer

Responses

Request samples

Content type
application/json
[
  • 1231245,
  • 4323423
]

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": "Successfully deleted the Candidates from TalentPool"
}

Users

Endpoint to search users with following role [enterprise users, client contacts and recruiters]

Search for Enterprise users with set filters.

Search for Enterprise users with set filters.

Authorizations:
JWTAuth
header Parameters
Authentication
any

JWT Authentication

Request Body schema: application/json
required

Supported filters to search Users: id, createdDate, updatedDate, employeeId, workllamaInterfaceId, workllamaUuid

companyCode
string
Array of objects (Root Type for JobFilter)
Array of objects (Root Type for SortCriteria)
pageSize
integer <int32>
pageNumber
integer <int32>

Responses

Request samples

Content type
application/json
Example
{
  • "companyCode": "YUPROUAT",
  • "filters": [
    ],
  • "sort": [
    ],
  • "pageSize": 100,
  • "pageNumber": 1
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "page": {
    },
  • "data": [
    ]
}