Welcome to the new Affinda Docs – explore the Academy, browse guides, or ask the AI assistant any questions you have!
curl --request POST \
--url https://{region}.affinda.com/v3/job_description_search/details/{identifier} \
--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": [
123
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"dataPoint": "isAvailable",
"query": {
"value": true
},
"required": true,
"weight": 0.5
}
]
}'
{
"jobTitle": {
"missing": [
"<string>"
],
"value": {
"name": "Javascript developer",
"companyName": "Affinda",
"match": true
}
},
"location": {
"missing": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"value": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123",
"match": true
}
},
"education": {
"missing": {
"degrees": [
"<string>"
],
"degreeTypes": [
"<string>"
]
},
"value": {
"degrees": [
"<string>"
],
"degreeTypes": [
"<string>"
],
"match": true
}
},
"skills": {
"missing": [
{
"name": "<string>",
"required": true
}
],
"value": [
{
"name": "Java Programming Language",
"match": true
}
]
},
"experience": {
"minimumExperience": 1,
"maximumExperience": 1,
"match": true
},
"occupationGroup": {
"missing": [
123
],
"value": {
"match": true,
"code": 123,
"name": "<string>",
"children": [
{
"code": 123,
"name": "<string>",
"children": [
{}
]
}
],
"parents": [
{
"code": 123,
"name": "<string>",
"children": [
{}
]
}
]
}
},
"languages": {
"missing": [
{
"name": "<string>",
"required": true
}
],
"value": [
{
"name": "English",
"match": true
}
]
},
"managementLevel": {
"level": "Low",
"match": true
},
"searchExpression": {
"missing": [
"<string>"
],
"value": [
"<string>"
]
}
}
This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description.
The identifier
is the unique ID returned via the /job_description_search endpoint.
curl --request POST \
--url https://{region}.affinda.com/v3/job_description_search/details/{identifier} \
--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": [
123
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"dataPoint": "isAvailable",
"query": {
"value": true
},
"required": true,
"weight": 0.5
}
]
}'
{
"jobTitle": {
"missing": [
"<string>"
],
"value": {
"name": "Javascript developer",
"companyName": "Affinda",
"match": true
}
},
"location": {
"missing": [
{
"name": "",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"distance": 100,
"unit": "km"
}
],
"value": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123",
"match": true
}
},
"education": {
"missing": {
"degrees": [
"<string>"
],
"degreeTypes": [
"<string>"
]
},
"value": {
"degrees": [
"<string>"
],
"degreeTypes": [
"<string>"
],
"match": true
}
},
"skills": {
"missing": [
{
"name": "<string>",
"required": true
}
],
"value": [
{
"name": "Java Programming Language",
"match": true
}
]
},
"experience": {
"minimumExperience": 1,
"maximumExperience": 1,
"match": true
},
"occupationGroup": {
"missing": [
123
],
"value": {
"match": true,
"code": 123,
"name": "<string>",
"children": [
{
"code": 123,
"name": "<string>",
"children": [
{}
]
}
],
"parents": [
{
"code": 123,
"name": "<string>",
"children": [
{}
]
}
]
}
},
"languages": {
"missing": [
{
"name": "<string>",
"required": true
}
],
"value": [
{
"name": "English",
"match": true
}
]
},
"managementLevel": {
"level": "Low",
"match": true
},
"searchExpression": {
"missing": [
"<string>"
],
"value": [
"<string>"
]
}
}
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.
Job Description identifier
"ELgrnBbM"
Search parameters
The body is of type object
.
Successfully retrieved detail search result.
The response is of type object
.