Welcome to the new Affinda Docs – explore the Academy, browse guides, or ask the AI assistant any questions you have!
curl --request GET \
--url https://{region}.affinda.com/v3/resume_search/config \
--header 'Authorization: Bearer <token>'
{
"allowPdfDownload": true,
"maxResults": 10,
"displayJobTitle": true,
"displayLocation": true,
"displayYearsExperience": true,
"displayOccupationGroup": true,
"displayEducation": true,
"displaySkills": true,
"displayLanguages": true,
"displayManagementLevel": true,
"displayKeywords": true,
"weightJobTitle": 123,
"weightLocation": 123,
"weightYearsExperience": 123,
"weightOccupationGroup": 123,
"weightEducation": 123,
"weightSkills": 123,
"weightLanguages": 123,
"weightManagementLevel": 123,
"weightKeywords": 123,
"indices": [
"all-resumes",
"my-index"
],
"showIndexDropdown": true,
"searchToolTheme": {
"palette": {
"mode": "light",
"background": "<string>",
"text": {
"primary": "<string>",
"secondary": "<string>",
"disabled": "<string>"
},
"divider": "<string>",
"primary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"secondary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"success": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"annotation": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"error": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"info": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"warning": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
}
},
"typography": {
"fontFamily": "<string>",
"fontSize": "<string>",
"fontWeightRegular": "<string>",
"fontWeightMedium": "<string>",
"fontWeightBold": "<string>"
},
"borderRadius": 123,
"fontUrl": "<string>"
},
"userId": 1234,
"username": "big.smoke",
"actions": [
{
"label": "Add to shortlist",
"eventName": "addToShortlist"
}
],
"hideToolbar": true,
"hideSidePanel": true,
"customFieldsConfig": [
{
"dataPoint": "RdNAniIH",
"weight": 0.5
}
],
"distanceUnit": "km"
}
Return configurations such as which fields can be displayed in the logged in user’s embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
curl --request GET \
--url https://{region}.affinda.com/v3/resume_search/config \
--header 'Authorization: Bearer <token>'
{
"allowPdfDownload": true,
"maxResults": 10,
"displayJobTitle": true,
"displayLocation": true,
"displayYearsExperience": true,
"displayOccupationGroup": true,
"displayEducation": true,
"displaySkills": true,
"displayLanguages": true,
"displayManagementLevel": true,
"displayKeywords": true,
"weightJobTitle": 123,
"weightLocation": 123,
"weightYearsExperience": 123,
"weightOccupationGroup": 123,
"weightEducation": 123,
"weightSkills": 123,
"weightLanguages": 123,
"weightManagementLevel": 123,
"weightKeywords": 123,
"indices": [
"all-resumes",
"my-index"
],
"showIndexDropdown": true,
"searchToolTheme": {
"palette": {
"mode": "light",
"background": "<string>",
"text": {
"primary": "<string>",
"secondary": "<string>",
"disabled": "<string>"
},
"divider": "<string>",
"primary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"secondary": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"success": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"annotation": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"error": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"info": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
},
"warning": {
"main": "<string>",
"light": "<string>",
"dark": "<string>",
"contrastText": "<string>"
}
},
"typography": {
"fontFamily": "<string>",
"fontSize": "<string>",
"fontWeightRegular": "<string>",
"fontWeightMedium": "<string>",
"fontWeightBold": "<string>"
},
"borderRadius": 123,
"fontUrl": "<string>"
},
"userId": 1234,
"username": "big.smoke",
"actions": [
{
"label": "Add to shortlist",
"eventName": "addToShortlist"
}
],
"hideToolbar": true,
"hideSidePanel": true,
"customFieldsConfig": [
{
"dataPoint": "RdNAniIH",
"weight": 0.5
}
],
"distanceUnit": "km"
}
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.
The config for the logged in user's embedable search tool.
The response is of type object
.