Skip to main content
POST
Search through parsed job descriptions

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. 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.

Query Parameters

offset
integer

The number of documents to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

limit
integer

The numbers of results to return.

Required range: 1 <= x <= 100
Example:

20

Body

application/json

Search parameters

indices
string[]
required
Example:
resume
string | null

A random string that uniquely identify the resource.

jobTitles
string[]
jobTitlesRequired
boolean
jobTitlesWeight
number
Required range: 0 <= x <= 1
totalYearsExperience
number | null
yearsExperienceRequired
boolean
yearsExperienceWeight
number
Required range: 0 <= x <= 1
locations
object[]
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
degrees
string[]
degreesRequired
boolean
degreeTypes
(enum<string> | null)[]
Available options:
school,
certificate,
bachelors,
masters,
doctoral
Example:

"bachelors"

degreeTypesRequired
boolean
educationWeight
number
Required range: 0 <= x <= 1
searchExpression
string | null
searchExpressionRequired
boolean
searchExpressionWeight
number
Required range: 0 <= x <= 1
socCodes
integer[]
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

Will return matching documents

count
integer

Total number of results

Required range: x >= 0
Example:

130

next
string | null

URL to request next page of results

Example:

"https://api.affinda.com/v3/search?limit=20&offset=20"

previous
string | null

URL to request previous page of results

Example:

"https://api.affinda.com/v3/search?limit=20"

parameters
object | null
results
object[]