curl --request POST \
--url https://{region}.affinda.com/v2/job_description_search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"indices": [
"all-job-descriptions"
],
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"totalYearsExperience": 123,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"degrees": [
"<string>"
],
"degreesRequired": true,
"degreeTypes": [
"bachelors"
],
"degreeTypesRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
5000
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"query": {
"value": true
},
"dataPoint": "isAvailable",
"field": "isAvailable",
"required": true,
"weight": 0.5
}
]
}
'{
"count": 130,
"next": "https://api.affinda.com/v2/search?limit=20&offset=20",
"previous": "https://api.affinda.com/v2/search?limit=20",
"parameters": {
"indices": [
"all-job-descriptions"
],
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"totalYearsExperience": 123,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"degrees": [
"<string>"
],
"degreesRequired": true,
"degreeTypes": [
"bachelors"
],
"degreeTypesRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
5000
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"query": {
"value": true
},
"dataPoint": "isAvailable",
"field": "isAvailable",
"required": true,
"weight": 0.5
}
]
},
"results": [
{
"identifier": "<string>",
"score": 0.98,
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Example-Job-Description",
"jobTitle": {
"label": "Job Title",
"value": "Software Developer",
"score": 0.68
},
"managementLevel": {
"label": "Management level",
"value": "Low",
"score": 0.68
},
"experience": {
"label": "Experience",
"value": "2.0 - 3.0 years",
"score": 0.68
},
"skills": {
"label": "Skills",
"value": "Python (Programming Language), Software Development",
"score": 0.68
},
"languages": {
"label": "Languages",
"value": "English",
"score": 0.68
},
"location": {
"label": "Location",
"value": "Roxburgh Park, Australia",
"score": 0.68
},
"education": {
"label": "Education",
"value": "Architecture Interior Design",
"score": 0.68
},
"searchExpression": {
"label": "Search expression",
"value": "<string>",
"score": 0.68
},
"organizationName": "Microsoft",
"customData": {},
"occupationGroup": {
"label": "Occupation group",
"value": "Programmers and software development professionals",
"score": 0.68
}
}
]
}Searches through parsed job descriptions. You can search with custom criterias or a resume.
curl --request POST \
--url https://{region}.affinda.com/v2/job_description_search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"indices": [
"all-job-descriptions"
],
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"totalYearsExperience": 123,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"degrees": [
"<string>"
],
"degreesRequired": true,
"degreeTypes": [
"bachelors"
],
"degreeTypesRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
5000
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"query": {
"value": true
},
"dataPoint": "isAvailable",
"field": "isAvailable",
"required": true,
"weight": 0.5
}
]
}
'{
"count": 130,
"next": "https://api.affinda.com/v2/search?limit=20&offset=20",
"previous": "https://api.affinda.com/v2/search?limit=20",
"parameters": {
"indices": [
"all-job-descriptions"
],
"resume": "<string>",
"jobTitles": [
"<string>"
],
"jobTitlesRequired": true,
"jobTitlesWeight": 0.5,
"totalYearsExperience": 123,
"yearsExperienceRequired": true,
"yearsExperienceWeight": 0.5,
"locations": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"locationsWeight": 0.5,
"locationsRequired": true,
"skills": [
{
"name": "<string>",
"required": true
}
],
"skillsWeight": 0.5,
"languages": [
{
"name": "<string>",
"required": true
}
],
"languagesWeight": 0.5,
"degrees": [
"<string>"
],
"degreesRequired": true,
"degreeTypes": [
"bachelors"
],
"degreeTypesRequired": true,
"educationWeight": 0.5,
"searchExpression": "<string>",
"searchExpressionRequired": true,
"searchExpressionWeight": 0.5,
"socCodes": [
5000
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"query": {
"value": true
},
"dataPoint": "isAvailable",
"field": "isAvailable",
"required": true,
"weight": 0.5
}
]
},
"results": [
{
"identifier": "<string>",
"score": 0.98,
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Example-Job-Description",
"jobTitle": {
"label": "Job Title",
"value": "Software Developer",
"score": 0.68
},
"managementLevel": {
"label": "Management level",
"value": "Low",
"score": 0.68
},
"experience": {
"label": "Experience",
"value": "2.0 - 3.0 years",
"score": 0.68
},
"skills": {
"label": "Skills",
"value": "Python (Programming Language), Software Development",
"score": 0.68
},
"languages": {
"label": "Languages",
"value": "English",
"score": 0.68
},
"location": {
"label": "Location",
"value": "Roxburgh Park, Australia",
"score": 0.68
},
"education": {
"label": "Education",
"value": "Architecture Interior Design",
"score": 0.68
},
"searchExpression": {
"label": "Search expression",
"value": "<string>",
"score": 0.68
},
"organizationName": "Microsoft",
"customData": {},
"occupationGroup": {
"label": "Occupation group",
"value": "Programmers and software development professionals",
"score": 0.68
}
}
]
}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.
The number of documents to skip before starting to collect the result set.
x >= 00
The numbers of results to return.
1 <= x <= 10020
Search parameters
["all-job-descriptions"]A random string that uniquely identify the resource.
0 <= x <= 10 <= x <= 1Show child attributes
0 <= x <= 10 <= x <= 10 <= x <= 1school, certificate, bachelors, masters, doctoral "bachelors"
0 <= x <= 10 <= x <= 11 <= x <= 99990 <= x <= 1None, Low, Mid, Upper "Low"
0 <= x <= 1Show child attributes
Data points of "text" type support only "equals" filterType, others support both "equals" and "range"
equals, range "equals"
"equals" searches require the "value" key inside the query, and "range" searches require at least one of "gte" (greater than or equal) and "lte" (less than or equal)
{ "value": true }The data point's slug, used for portal v2 (deprecated)
"isAvailable"
The field's slug
"isAvailable"
0 <= x <= 1Will return matching documents
Total number of results
x >= 0130
URL to request next page of results
"https://api.affinda.com/v2/search?limit=20&offset=20"
URL to request previous page of results
"https://api.affinda.com/v2/search?limit=20"
Show child attributes
["all-job-descriptions"]A random string that uniquely identify the resource.
0 <= x <= 10 <= x <= 1Show child attributes
x >= 1km, mi 0 <= x <= 10 <= x <= 10 <= x <= 1school, certificate, bachelors, masters, doctoral "bachelors"
0 <= x <= 10 <= x <= 11 <= x <= 99990 <= x <= 1None, Low, Mid, Upper "Low"
0 <= x <= 1Show child attributes
Data points of "text" type support only "equals" filterType, others support both "equals" and "range"
equals, range "equals"
"equals" searches require the "value" key inside the query, and "range" searches require at least one of "gte" (greater than or equal) and "lte" (less than or equal)
{ "value": true }The data point's slug, used for portal v2 (deprecated)
"isAvailable"
The field's slug
"isAvailable"
0 <= x <= 1Show child attributes
A random string that uniquely identify the resource.
0.98
"https://affinda-api.s3.amazonaws.com/media/documents/Example-Job-Description"
"Microsoft"