> ## Documentation Index
> Fetch the complete documentation index at: https://docs.collective.work/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Sherlock search results

> Poll the status and results of a talent search. While the search runs, `status` is `ONGOING` and `results` is `null`. Once `COMPLETED`, `results` is an array (possibly empty) of ranked **summary** profiles ordered by descending match score, capped at your organisation's per-call limit (30 by default).

Summary results do not include contact details or the CV — use the [Get Profile](/api-reference/endpoint/profile/get) endpoint to retrieve them.



## OpenAPI

````yaml GET /sherlock/search/{searchId}
openapi: 3.0.1
info:
  title: Collective Work Job API
  description: API for managing job postings on the Collective Work platform
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.collective.work/{environment}/v1
    description: Collective Work API server
    variables:
      environment:
        default: sandbox
        description: API environment
        enum:
          - sandbox
          - production
security:
  - bearerAuth: []
paths:
  /sherlock/search/{searchId}:
    get:
      description: >-
        Poll the status and results of a talent search. While the search runs,
        `status` is `ONGOING` and `results` is `null`. Once `COMPLETED`,
        `results` is an array (possibly empty) of ranked **summary** profiles
        ordered by descending match score, capped at your organisation's
        per-call limit (30 by default).


        Summary results do not include contact details or the CV — use the [Get
        Profile](/api-reference/endpoint/profile/get) endpoint to retrieve them.
      parameters:
        - in: path
          name: searchId
          schema:
            type: string
          required: true
          description: Unique identifier of the search returned when it was launched
      responses:
        '200':
          description: Search status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PollSherlockSearchResponseDto'
        '403':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Search not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  schemas:
    PollSherlockSearchResponseDto:
      type: object
      required:
        - searchId
        - status
        - results
      properties:
        searchId:
          type: string
          description: Unique identifier of the search
          example: cm71yqftr00000ck0bpz3hpg1
        status:
          type: string
          enum:
            - ONGOING
            - COMPLETED
            - FAILED
          description: Current status of the search
          example: COMPLETED
        results:
          type: array
          nullable: true
          description: >-
            Ranked results. Null until the search reaches `COMPLETED`; then an
            array (possibly empty) ordered by descending match score and capped
            at the org per-call limit (30 by default).
          items:
            $ref: '#/components/schemas/SherlockSearchResultDto'
    Error403:
      type: object
      required:
        - message
        - error
        - statusCode
      properties:
        message:
          type: array
          items:
            type: string
        statusCode:
          type: integer
          example: 403
        error:
          type: string
          example: Forbidden
    Error404:
      type: object
      required:
        - message
        - error
        - statusCode
      properties:
        message:
          type: array
          items:
            type: string
          example:
            - Resource not found
        statusCode:
          type: integer
          example: 404
        error:
          type: string
          example: Not Found
    Error500:
      type: object
      required:
        - message
        - error
        - statusCode
      properties:
        message:
          type: array
          items:
            type: string
          example:
            - Internal server error
        statusCode:
          type: integer
          example: 500
        error:
          type: string
          example: Internal Server Error
    SherlockSearchResultDto:
      type: object
      required:
        - score
        - reasons
        - profile
      properties:
        score:
          type: number
          description: Match score between 0 and 100 (higher is a better match)
          example: 82
        reasons:
          type: array
          description: Reasons explaining the match
          items:
            $ref: '#/components/schemas/SherlockSearchResultReasonDto'
        profile:
          description: >-
            Summary profile of the matched talent. Use the Get Profile endpoint
            to fetch full details, contact information and CV.
          allOf:
            - $ref: '#/components/schemas/ApiProfileSummaryDto'
    SherlockSearchResultReasonDto:
      type: object
      required:
        - text
        - isPositive
      properties:
        text:
          type: string
          description: Human-readable reason explaining the match
          example: Has 6 years of React experience matching the brief
        isPositive:
          type: boolean
          description: Whether this reason supports (true) or weakens (false) the match
          example: true
    ApiProfileSummaryDto:
      type: object
      required:
        - id
        - firstname
        - lastname
        - pictureUrl
        - linkedinUrl
        - collectiveUrl
        - title
        - dailyRate
        - yearlySalaryMin
        - yearlySalaryMax
        - availability
        - workPreference
        - desiredContractType
        - location
        - mobilities
        - skills
        - featuredSkills
        - workExperiences
      properties:
        id:
          type: string
          description: Unique identifier of the talent
          example: cm71yqftr00000ck0bpz3hpg1
        firstname:
          type: string
          description: First name of the talent
          example: Jane
        lastname:
          type: string
          description: Last name of the talent
          example: Doe
        pictureUrl:
          type: string
          nullable: true
          description: Profile picture URL
          example: https://pictures.example.com/jane.png
        linkedinUrl:
          type: string
          nullable: true
          description: LinkedIn profile URL of the talent (may be null when unknown)
          example: https://www.linkedin.com/in/jane-doe
        collectiveUrl:
          type: string
          description: >-
            Deep link to open the talent profile inside the Collective recruiter
            app
          example: >-
            https://app.collective.work/recruiter/search?profileId=cmjr2j27g2xzy6dgjauv8hbc1
        title:
          type: string
          nullable: true
          description: Professional headline / title
          example: Senior Frontend Engineer
        dailyRate:
          type: number
          nullable: true
          description: Desired daily rate in euros
          example: 650
        yearlySalaryMin:
          type: number
          nullable: true
          description: Minimum desired yearly salary in euros
          example: 60000
        yearlySalaryMax:
          type: number
          nullable: true
          description: Maximum desired yearly salary in euros
          example: 80000
        availability:
          type: string
          nullable: true
          enum:
            - AVAILABLE
          description: >-
            Whether the talent is available now. Returns `AVAILABLE`, or `null`
            when the talent is not available or has not set their availability.
            Resolved the same way as the Collective app.
          example: AVAILABLE
        workPreference:
          type: string
          nullable: true
          enum:
            - REMOTE_ONLY
            - FLEXIBLE
          description: Preferred way of working
          example: REMOTE_ONLY
        desiredContractType:
          type: string
          nullable: true
          enum:
            - FREELANCER
            - FREELANCER_OPEN_TO_PERMANENT_CONTRACT
            - PERMANENT_CONTRACT
          description: Desired contract type
          example: FREELANCER
        location:
          description: Primary work location
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ApiLocationDto'
        mobilities:
          type: array
          description: Locations the talent is willing to work in
          items:
            $ref: '#/components/schemas/ApiLocationDto'
        skills:
          type: array
          description: Skills
          items:
            type: string
          example:
            - TypeScript
            - GraphQL
        featuredSkills:
          type: array
          description: >-
            Featured skills — the skills the talent is best at (a highlighted
            subset of `skills`)
          items:
            type: string
          example:
            - React
        workExperiences:
          type: array
          description: Most recent work experiences (up to 3)
          items:
            $ref: '#/components/schemas/ApiSummaryWorkExperienceDto'
    ApiLocationDto:
      type: object
      required:
        - googleMapsPlaceId
        - country
        - countryCode
        - label
        - shortLabel
        - latitude
        - longitude
      properties:
        googleMapsPlaceId:
          type: string
          nullable: true
          description: Google Maps place identifier, usable to re-query the location
          example: ChIJdw3OtdnQZ0cRziAfbWk74Go
        country:
          type: string
          nullable: true
          description: Full English country name
          example: France
        countryCode:
          type: string
          nullable: true
          description: ISO 3166-1 alpha-2 country code
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - CV
            - KH
            - CM
            - CA
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - SZ
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MK
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - GB
            - UM
            - US
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - XK
            - YE
            - ZM
            - ZW
          example: FR
        label:
          type: string
          nullable: true
          description: Full display label of the location
          example: Paris, France
        shortLabel:
          type: string
          nullable: true
          description: Short display label of the location
          example: Paris
        latitude:
          type: number
          nullable: true
          description: Latitude of the location
          example: 48.8566
        longitude:
          type: number
          nullable: true
          description: Longitude of the location
          example: 2.3522
    ApiSummaryWorkExperienceDto:
      type: object
      required:
        - title
        - company
        - companyLogoUrl
        - startDate
        - endDate
      properties:
        title:
          type: string
          description: Job title held
          example: Senior Frontend Engineer
        company:
          type: string
          nullable: true
          description: Company name
          example: Collective
        companyLogoUrl:
          type: string
          nullable: true
          description: Company logo URL
          example: https://logo.example.com/collective.png
        startDate:
          type: string
          format: date-time
          nullable: true
          description: Start date of the experience
          example: '2021-01-01T00:00:00.000Z'
        endDate:
          type: string
          format: date-time
          nullable: true
          description: End date of the experience (null if ongoing)
          example: '2023-06-30T00:00:00.000Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Your organization API key, available in [Organisation
        settings](https://app.collective.work/recruiter/organization/api).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.