Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB
Search & Match - Searching

Search through parsed job descriptions

Searches through parsed job descriptions. You can search with custom criterias or a resume.

post/v2/job_description_search

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger
Example:20

The numbers of results to return.

Request body

indicesstring[] required
resumestring

A random string that uniquely identify the resource.

jobTitlesstring[]
jobTitlesRequiredboolean
jobTitlesWeightnumber
totalYearsExperiencenumber nullable
yearsExperienceRequiredboolean
yearsExperienceWeightnumber
locationsWeightnumber
locationsRequiredboolean
skillsWeightnumber
languagesWeightnumber
degreesstring[]
degreesRequiredboolean
degreeTypesEducationLevel[]
degreeTypesRequiredboolean
educationWeightnumber
searchExpressionstring nullable
searchExpressionRequiredboolean
searchExpressionWeightnumber
socCodesinteger[]
socCodesWeightnumber
socCodesRequiredboolean
managementLevel'None' | 'Low' | 'Mid' | 'Upper' nullable
managementLevelRequiredboolean
managementLevelWeightnumber

Example request

{
  "indices": [
    "all-job-descriptions"
  ],
  "degreeTypes": [
    "bachelors"
  ],
  "managementLevel": "Low",
  "customData": [
    {
      "filterType": "equals",
      "dataPoint": "isAvailable",
      "field": "isAvailable",
      "query": {
        "value": true
      }
    }
  ]
}

Response

Will return matching documents

countinteger

Total number of results

nextstring nullable

URL to request next page of results

previousstring nullable

URL to request previous page of results

Example response

{
  "count": 130,
  "next": "https://api.affinda.com/v3/search?limit=20&offset=20",
  "previous": "https://api.affinda.com/v3/search?limit=20",
  "parameters": {
    "indices": [
      "all-job-descriptions"
    ],
    "degreeTypes": [
      "bachelors"
    ],
    "managementLevel": "Low",
    "customData": [
      {
        "filterType": "equals",
        "dataPoint": "isAvailable",
        "field": "isAvailable",
        "query": {
          "value": true
        }
      }
    ]
  },
  "results": [
    {
      "score": 0.98,
      "pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Example-Job-Description",
      "jobTitle": {
        "value": "Software Developer",
        "label": "Job Title",
        "score": 0.68
      },
      "managementLevel": {
        "value": "Low",
        "label": "Management level",
        "score": 0.68
      },
      "experience": {
        "value": "2.0 - 3.0 years",
        "label": "Experience",
        "score": 0.68
      },
      "skills": {
        "value": "Python (Programming Language), Software Development",
        "label": "Skills",
        "score": 0.68
      },
      "languages": {
        "value": "English",
        "label": "Languages",
        "score": 0.68
      },
      "location": {
        "value": "Roxburgh Park, Australia",
        "label": "Location",
        "score": 0.68
      },
      "education": {
        "value": "Architecture Interior Design",
        "label": "Education",
        "score": 0.68
      },
      "occupationGroup": {
        "value": "Programmers and software development professionals",
        "label": "Occupation group",
        "score": 0.68
      },
      "searchExpression": {
        "label": "Search expression",
        "score": 0.68
      },
      "organizationName": "Microsoft"
    }
  ]
}