v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB

Search & Match - Embedding

Get the config for the logged in user's embeddable resume search tool

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.

get/v2/resume_search/config

Response

The config for the logged in user's embedable search tool.

allowPdfDownloadboolean

maxResultsinteger nullable

Maximum number of results that can be returned. Setting to "null" means no limitation.

displayJobTitleboolean

displayLocationboolean

displayYearsExperienceboolean

displayOccupationGroupboolean

displayEducationboolean

displaySkillsboolean

displayLanguagesboolean

displayManagementLevelboolean

displayKeywordsboolean

weightJobTitlenumber

weightLocationnumber

weightYearsExperiencenumber

weightOccupationGroupnumber

weightEducationnumber

weightSkillsnumber

weightLanguagesnumber

weightManagementLevelnumber

weightKeywordsnumber

indicesstring[]

List of index names.

showIndexDropdownboolean nullable

Controls whether or not the index dropdown is displayed to the user

userIdinteger

ID of the logged in user.

usernamestring

Username of the logged in user.

hideToolbarboolean

Hide the reset/import toolbar.

hideSidePanelboolean

Hide the entire side panel.

distanceUnit'mi' | 'km'

The unit of distance to use for location based searches

Example response

{
  "maxResults": 10,
  "indices": [
    "all-resumes",
    "my-index"
  ],
  "userId": 1234,
  "username": "big.smoke",
  "actions": [
    {
      "label": "Add to shortlist",
      "eventName": "addToShortlist"
    }
  ],
  "customFieldsConfig": [
    {
      "dataPoint": "RdNAniIH",
      "weight": 0.5
    }
  ],
  "distanceUnit": "km"
}