{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"00ef91d0-6b6a-4145-b416-0bbc053904d9","name":"theMatchBox API Guide v2","description":"### Overview\n\nThis guide covers the basic steps to setup searching and matching from scratch. It contains some sample data so that all examples return som reasonable results.\n\n### Test-URL and Authorization\n\nTo run all calls, one needs a url to a test instance and an API key to retrieve a bearer access token. Please contact us to get both a demo environment and API key.\n\n### theMatchBox Aspects\n\nAll data needed for searching and matching is stored in an Elasticsearch index. However, theMatchBox extended Elasticsearch with extra data types, called aspects.\n\nThe difference between aspect fields and regular fields is that aspects carry meaning. The aspect type defines what kind of data is stored in the field: a job title, a hard skill, known languages... theMatchBox services use this aspect information to improve searching and matching, e.g. by using synonyms for hard skills or to extract a job function from the job title.\n\nSome of the aspect types are matching aspect types: they can be used to calculate a matching score.\n\n### Supported aspect types\n\n| **Aspect Type** | **Meaning** | **Is matching type** | **Profile type** | **Field type** |\n| --- | --- | --- | --- | --- |\n| PROFILE_LANGUAGE | the main language used in this profile | no | any | keyword |\n| PROFILE_LOCALE | the locale for this profile | no | any | keyword |\n| JOB_FUNCTION | list of job functions | yes | any | concept |\n| HARD_SKILL | list of hard skills | yes | any | concept |\n| SOFT_SKILL | list of soft skills | yes | any | concept |\n| LANGUAGE_KNOWLEDGE | list of languages | yes | any | concept |\n| CERTIFICATION | list of certifications | yes | any | concept |\n| DRIVING_LICENSE | list of driving licenses | yes | any | concept |\n| EDUCATION | list of educations | yes | any | concept |\n| SENIORITY | the seniority for this profile | yes | any | keyword |\n| WORKING_HOURS | working hours like part time, full time... | yes | any | keyword |\n| CONTRACT_TYPE | the type of the contract like permanent or temporary... | yes | any | keyword |\n| SHIFT_TYPE | the type of shift like day jobs, weekend jobs, 3-shift system... | yes | any | keyword |\n| DOMAIN | the domain of this profile, is close the actual content of a job, e.g. accountancy or software development. | yes | any | keyword |\n| SECTOR | the sector of this profile, in which context a job is executed, e.g. in automotive or retail. | yes | any | keyword |\n| WAGE | the expected or desired wage | yes | any | float range |\n| LOCATION | the expected or desired location | yes | any | geo-location |\n| JOB_TITLE | the full title of a job | no | job | rich text |\n| JOB_TEXT | the entire job text | no | job | rich text |\n| CV_TEXT | the content of a cv (not binary, but already converted to text). | no | candidate | rich text |\n| CV_LANGUAGE | the language of the cv (might differ from the profile language) | no | candidate | keyword |\n| WORK_EXPERIENCE | container for the work experience fields | no | candidate | nested |\n| WORK_EXPERIENCE_TITLE | the job title of a work experience | no | candidate | rich text |\n| WORK_EXPERIENCE_TEXT | the text of a work experience | no | candidate | rich text |\n| WORK_EXPERIENCE_COMPANY | the company | no | candidate | rich text |\n| WORK_EXPERIENCE_FROM | the date, month or year started | no | candidate | date |\n| WORK_EXPERIENCE_TO | the date, month or year stopped | no | candidate | date |\n| EDUCATION_HISTORY | container for education history | no | candidate | nested |\n| EDUCATION_HISTORY_FIELD | the education field like e.g. legal, biology, mathematics... | no | candidate | rich text |\n| EDUCATION_HISTORY_DEGREE | the degree like bachelor, master, phd... | no | candidate | rich text |\n| EDUCATION_HISTORY_INSTITUTE | the name of the education institure | no | candidate | rich text |\n| EDUCATION_HISTORY_INFO | some extra education info | no | candidate | rich text |\n| EDUCATION_HISTORY_FROM | the date, month or year started | no | candidate | date |\n| EDUCATION_HISTORY_TO | the date, month or year stopped | no | candidate | date |\n| PREFERRED_JOB_TITLE | the job a candidate prefers to find | no | candidate | rich text |\n| PREFERRED_JOB_INFO | description of the job a candidate prefers | no | candidate | rich text |\n| CUSTOM_CONCEPT | a custom concept aspect | yes | any | concept |\n| CUSTOM_KEYWORD | a custom keyword aspect | yes | any | keyword |\n| CUSTOM_LOCATION | a custom location aspect | yes | any | geo-location |\n| CUSTOM_INTEGER | a custom integer aspect | yes | any | integer |\n| CUSTOM_INTEGER_RANGE | a custom integer range aspect | yes | any | integer range |\n| CUSTOM_FLOAT | a custom float aspect | yes | any | float |\n| CUSTOM_FLOAT_RANGE | a custom float range aspect | yes | any | float range |\n| CUSTOM_DOUBLE | a custom double aspect | yes | any | double |\n| CUSTOM_DOUBLE_RANGE | a custom double range aspect | yes | any | double range |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"410546","team":522402,"collectionId":"00ef91d0-6b6a-4145-b416-0bbc053904d9","publishedId":"UyxnDQBa","public":true,"publicUrl":"https://api-guide-v2.thematchbox.be","privateUrl":"https://go.postman.co/documentation/410546-00ef91d0-6b6a-4145-b416-0bbc053904d9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-05-19T00:48:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7e4147743b74038f752cf0c1c5596bc269fa1c620ad44f5648b3f59350df9a52","favicon":"https://thematchbox.be/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-guide-v2.thematchbox.be/view/metadata/UyxnDQBa"}