Skip to main content
POST
Get search result of specific resume

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

identifier
string
required

Resume identifier

Example:

"ELglqBbT"

Body

application/json

Search parameters

indices
string[]
required
Example:
jobDescription
string | null

A random string that uniquely identify the resource.

resume
string | null

A random string that uniquely identify the resource.

jobTitles
string[]
jobTitlesCurrentOnly
boolean

Search only through the canditate's current job

jobTitlesRequired
boolean
jobTitlesWeight
number
Required range: 0 <= x <= 1
yearsExperienceMin
integer | null

Minimum years of total work experience

Required range: x >= 0
yearsExperienceMax
integer | null

Maximum years of total work experience

Required range: x >= 0
yearsExperienceRequired
boolean
yearsExperienceWeight
number
Required range: 0 <= x <= 1
locations
object[]

Search by location name or by coordinates

locationsWeight
number
Required range: 0 <= x <= 1
locationsRequired
boolean
skills
object[]
skillsWeight
number
Required range: 0 <= x <= 1
languages
object[]
languagesWeight
number
Required range: 0 <= x <= 1
institutions
string[]
institutionsRequired
boolean
degrees
string[]
degreesRequired
boolean
highestDegreeTypes
(enum<string> | null)[]
Available options:
school,
certificate,
bachelors,
masters,
doctoral
Example:

"bachelors"

highestDegreeTypesRequired
boolean
isCurrentStudent
boolean

Search for student canditates

isCurrentStudentRequired
boolean
isRecentGraduate
boolean

Search for canditates that graduated less than a year ago

isRecentGraduateRequired
boolean
educationWeight
number
Required range: 0 <= x <= 1
searchExpression
string | null

Search through resumes' raw text

searchExpressionRequired
boolean
searchExpressionWeight
number
Required range: 0 <= x <= 1
socCodes
integer[]

A list of occupation group IDs, more details can be found in the <occupation_groups> endpoint

Required range: 1 <= x <= 9999
socCodesWeight
number
Required range: 0 <= x <= 1
socCodesRequired
boolean
managementLevel
enum<string> | null
Available options:
None,
Low,
Mid,
Upper
Example:

"Low"

managementLevelRequired
boolean
managementLevelWeight
number
Required range: 0 <= x <= 1
customData
object[]

Response

Successfully retrieved detail search result.

jobTitle
object
location
object
education
object
skills
object
experience
object
occupationGroup
object
languages
object
managementLevel
object | null
searchExpression
object