---
title: "Get search result of specific job description"
method: POST
path: "/v3/job_description_search/details/{identifier}"
tags: ["Search & Match"]
---

# Get search result of specific job description

`POST /v3/job_description_search/details/{identifier}`

## Request

- Base URL: `https://api.affinda.com`
- URL: `https://api.affinda.com/v3/job_description_search/details/{identifier}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/affinda/apis/affinda-api/docs/v3/job_description_search/details/:identifier/post.ts> (a function with typed inputs; its response is checked against the schema)

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](#post-/job_description_search) endpoint.

## Path parameters

- `identifier` string, required

## Request body

- JobDescriptionSearchParameters, nullable
  - `indices` string[], required
  - `resume` string: A random string that uniquely identify the resource.
  - `jobTitles` string[]
  - `jobTitlesRequired` boolean
  - `jobTitlesWeight` number
  - `totalYearsExperience` number, nullable
  - `yearsExperienceRequired` boolean
  - `yearsExperienceWeight` number
  - `locations` ResumeSearchParametersLocation[]
    - `name` string
    - `coordinates` object, nullable
      - `latitude` number, nullable
      - `longitude` number, nullable
    - `distance` integer
    - `unit` 'km' | 'mi'
  - `locationsWeight` number
  - `locationsRequired` boolean
  - `skills` ResumeSearchParametersSkill[]
    - `name` string
    - `required` boolean
  - `skillsWeight` number
  - `languages` ResumeSearchParametersSkill[]
    - `name` string
    - `required` boolean
  - `languagesWeight` number
  - `degrees` string[]
  - `degreesRequired` boolean
  - `degreeTypes` EducationLevel[]
  - `degreeTypesRequired` boolean
  - `educationWeight` number
  - `searchExpression` string, nullable
  - `searchExpressionRequired` boolean
  - `searchExpressionWeight` number
  - `socCodes` integer[]
  - `socCodesWeight` number
  - `socCodesRequired` boolean
  - `managementLevel` 'None' | 'Low' | 'Mid' | 'Upper', nullable
  - `managementLevelRequired` boolean
  - `managementLevelWeight` number
  - `customData` SearchParametersCustomData[]
    - `filterType` 'equals' | 'range', required: Data points of "text" type support only "equals" filterType, others support both "equals" and "range"
    - `dataPoint` string, nullable: The data point's slug, used for portal v2 (deprecated)
    - `field` string, nullable: The field's slug
    - `query` object, required: "equals" searches require the "value" key inside the query, and "range" searches require at least one of "gte" (greater than or equal) and "lte" (less than or equal)
    - `required` boolean
    - `weight` number

## Response `200`

Successfully retrieved detail search result.

- JobDescriptionSearchDetail
  - `jobTitle` object
    - `missing` string[]
    - `value` object
      - `name` string, nullable
      - `companyName` string, nullable
      - `match` boolean
  - `location` object
    - `missing` ResumeSearchParametersLocation[]
      - `name` string
      - `coordinates` object, nullable
        - `latitude` number, nullable
        - `longitude` number, nullable
      - `distance` integer
      - `unit` 'km' | 'mi'
    - `value` object, nullable
      - `formatted` string, nullable
      - `postalCode` string, nullable
      - `state` string, nullable
      - `stateCode` string, nullable
      - `country` string, nullable
      - `countryCode` string, nullable: Two letter country code (ISO 3166-1 alpha-2)
      - `rawInput` string, required
      - `streetNumber` string, nullable
      - `street` string, nullable
      - `apartmentNumber` string, nullable
      - `city` string, nullable
      - `latitude` number, nullable
      - `longitude` number, nullable
      - `poBox` string, nullable
      - `match` boolean
  - `education` object
    - `missing` object
      - `degrees` string[]
      - `degreeTypes` string[]
    - `value` object
      - `degrees` string[]
      - `degreeTypes` string[]
      - `match` boolean
  - `skills` object
    - `missing` ResumeSearchParametersSkill[]
      - `name` string
      - `required` boolean
    - `value` object[]
      - `name` string
      - `match` boolean
  - `experience` object
    - `minimumExperience` integer, nullable
    - `maximumExperience` integer, nullable
    - `match` boolean
  - `occupationGroup` object
    - `missing` integer[]
    - `value` OccupationGroupSearchResult
      - `match` boolean
      - `code` integer, required
      - `name` string, required
      - `children` OccupationGroup[]
        - `code` integer, required
        - `name` string, required
        - `children` OccupationGroup[], required
      - `parents` OccupationGroup[]
        - `code` integer, required
        - `name` string, required
        - `children` OccupationGroup[], required
  - `languages` object
    - `missing` ResumeSearchParametersSkill[]
      - `name` string
      - `required` boolean
    - `value` object[]
      - `name` string
      - `match` boolean
  - `managementLevel` object, nullable
    - `level` 'None' | 'Low' | 'Mid' | 'Upper', nullable
    - `match` boolean
  - `searchExpression` object
    - `missing` string[]
    - `value` string[]

## Other responses

- `400`: Bad request. If it is a validation error will contain a list of each invalid field
- `401`: Authorisation error
- `default`: UnexpectedError

---

[API](https://skmtc.dev/affinda/apis/affinda-api.md) - [All operations](https://skmtc.dev/affinda/apis/affinda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/affinda/apis/affinda-api/revisions/5f71e092a3e8?raw)