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

# FindSimilarJobPostings

> Find related job postings



## OpenAPI

````yaml https://edge.test.sterndesk.com/api/openapi.yaml post /rpc/rpc.v1.OrganizationService/FindSimilarJobPostings
openapi: 3.1.0
info:
  title: Sterndesk API
  version: 1.0.0
  description: >
    HTTP/JSON access to the Sterndesk data available to your account.


    Every Sterndesk operation is a Connect RPC: send `POST <path>` with a JSON
    body and the

    `Connect-Protocol-Version: 1` header. Authenticate with a personal API key

    (Settings → My account → API keys) using `Authorization: Bearer <key>`.


    A key reads everything documented here. The one write operation is uploading
    candidate

    documents, which needs a key carrying the `sterndesk:documents:write`
    permission; permissions

    are chosen when the key is created and are never added to an existing key.
    Every other write

    operation is rejected.


    ## Uploading candidate documents


    An upload is a batch of documents, the same batch a recruiter hands to
    Sterndesk from the

    dashboard. It may hold the documents of one candidate or of several people:
    Sterndesk groups

    them by identity and creates one candidate per person. Sending them takes
    two calls.


    1. `POST /rpc/rpc.v1.OrganizationService/CreateManualUpload` creates the
    upload and returns a
       signed, time-limited instruction: `upload_url`, `params`, `signature` and `expires_at`,
       together with the limits the upload must satisfy.
    2. `POST /assemblies` sends the files to Transloadit, the upload processor,
    as
       `multipart/form-data`, with `params` and `signature` as form fields. Send both verbatim:
       the signature covers those exact bytes, so pretty-printing `params`, reordering its keys,
       or parsing and re-encoding it invalidates the signature. The files go straight to
       Transloadit and never pass through Sterndesk.

    Processing then continues asynchronously, exactly as it does for a dashboard
    upload.

    `POST /rpc/rpc.v1.OrganizationService/ListManualUploads` reports the
    progress of the upload

    created in step 1.
servers:
  - url: https://edge.sterndesk.com
security:
  - apiKey: []
tags:
  - name: rpc.v1.OrganizationService
    description: Organization service RPC for organization method.
  - name: rpc.v1.RootService
    description: RootService provides top-level RPCs.
paths:
  /rpc/rpc.v1.OrganizationService/FindSimilarJobPostings:
    post:
      tags:
        - rpc.v1.OrganizationService
      summary: FindSimilarJobPostings
      description: Find related job postings
      operationId: rpc.v1.OrganizationService.FindSimilarJobPostings
      parameters:
        - name: Connect-Protocol-Version
          in: header
          description: Define the version of the Connect protocol
          required: true
          schema:
            $ref: '#/components/schemas/connect-protocol-version'
          example: 1
        - name: Connect-Timeout-Ms
          in: header
          description: Define the timeout, in ms
          schema:
            $ref: '#/components/schemas/connect-timeout-header'
          example: 1000
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rpc.v1.FindSimilarJobPostingsRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpc.v1.FindSimilarJobPostingsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
components:
  schemas:
    connect-protocol-version:
      type: number
      examples:
        - 1
      title: Connect-Protocol-Version
      description: Define the version of the Connect protocol
      const: 1
    connect-timeout-header:
      type: number
      examples:
        - 1000
      title: Connect-Timeout-Ms
      description: Define the timeout, in ms
    rpc.v1.FindSimilarJobPostingsRequest:
      type: object
      properties:
        organizationId:
          type: string
          title: organization_id
          format: uuid
          description: id of the organization in which job postings will be searched.
        jobPostingId:
          type: string
          title: job_posting_id
          format: uuid
          description: id of the job posting to find similar items for
        page:
          type: string
          title: page
          minimum: 1
          format: int64
          description: page of search results to return
        careerSiteId:
          type:
            - string
            - 'null'
          title: career_site_id
          format: uuid
          description: id of the career site in which job postings will be searched.
        perPage:
          type: string
          title: per_page
          minimum: 1
          format: int64
          description: nr of items per page
        languagesIso6393:
          type: array
          items:
            type: string
            maxLength: 3
            minLength: 3
          title: languages_iso639_3
          description: languages in iso 639-3 format.
        states:
          type: array
          items:
            $ref: '#/components/schemas/rpc.v1.JobPostingState'
          title: states
          description: possible states of a job posting.
        filterByAssigneeIds:
          type: array
          items:
            type: string
            format: uuid
          title: filter_by_assignee_ids
          maxItems: 5
          description: filter on job postings assigned to one of these member ids.
        filterByPipelineIds:
          type: array
          items:
            type: string
            format: uuid
          title: filter_by_pipeline_ids
          maxItems: 5
          description: filter on job postings belonging to one of these pipeline ids.
        filterByNoAssignees:
          type: boolean
          title: filter_by_no_assignees
          description: filter on job postings that have no assigned members.
        slot1FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot1_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot2FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot2_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot3FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot3_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot4FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot4_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot5FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot5_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot6FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot6_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot7FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot7_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot8FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot8_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot9FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot9_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
        slot10FilterValue:
          type: array
          items:
            type: string
            format: uuid
          title: slot10_filter_value
          description: >-
            filter on job postings matching any value for the filter on this
            slot.
      title: FindSimilarJobPostingsRequest
      additionalProperties: false
      description: request for searching job postings
    rpc.v1.FindSimilarJobPostingsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/rpc.v1.SearchJobPostingsResponse.Item'
          title: items
          description: search results
        totalFound:
          type: string
          title: total_found
          format: int64
          description: total number of search results
        totalPages:
          type: string
          title: total_pages
          format: int64
          description: total number of pages for all results
        currentPage:
          type: string
          title: current_page
          format: int64
          description: current page in the search results
      title: FindSimilarJobPostingsResponse
      additionalProperties: false
      description: response from searching job postings
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/connect.error_details.Any'
          description: >-
            A list of messages that carry the error details. There is no limit
            on the number of messages.
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    rpc.v1.JobPostingState:
      type: string
      title: JobPostingState
      enum:
        - JOB_POSTING_STATE_UNSPECIFIED
        - JOB_POSTING_STATE_OPEN
        - JOB_POSTING_STATE_CLOSED
      description: state of a job posting
    rpc.v1.SearchJobPostingsResponse.Item:
      type: object
      properties:
        id:
          type: string
          title: id
          description: id of the job posting
        title:
          type: string
          title: title
          description: title of the job posting
        summary:
          type: string
          title: summary
          description: summary of the job posting
        textMatch:
          type: string
          title: text_match
          format: int64
          description: text match of the search result
        shortId:
          type: string
          title: short_id
          format: int64
          description: the short id of the job posting
        organizationId:
          type: string
          title: organization_id
          description: id of the organization.
        careerSiteId:
          type:
            - string
            - 'null'
          title: career_site_id
          description: id of the career site the job posting is under (if any).
        languagesIso6393:
          type: string
          title: languages_iso639_3
          description: language the posting is in.
        vectorDistance:
          type:
            - number
            - 'null'
          title: vector_distance
          format: float
          description: the distance in the "embeddings" vector space
        pinned:
          type:
            - boolean
            - 'null'
          title: pinned
          description: show whether the job posting has been pinned
        state:
          oneOf:
            - $ref: '#/components/schemas/rpc.v1.JobPostingState'
            - type: 'null'
          title: state
          description: state of the job posting
        nrOfApplications:
          type: string
          title: nr_of_applications
          format: int64
          description: how many applications the job posting has
        assignedMembers:
          type: array
          items:
            $ref: '#/components/schemas/rpc.v1.Member'
          title: assigned_members
          description: member information that is assigned.
        pipelineId:
          type: string
          title: pipeline_id
          description: id of the pipeline
        crewRequest:
          oneOf:
            - $ref: >-
                #/components/schemas/rpc.v1.LinkedCrewRequestPositionWithJobPosting
            - type: 'null'
          title: crew_request
          description: linked a crew request with job posting
        createdAt:
          allOf:
            - $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          description: time at which the job post was created
        slot1FilterValue:
          type: array
          items:
            type: string
          title: slot1_filter_value
          description: values for each slot (if any)
        slot2FilterValue:
          type: array
          items:
            type: string
          title: slot2_filter_value
          description: values for each slot (if any)
        slot3FilterValue:
          type: array
          items:
            type: string
          title: slot3_filter_value
          description: values for each slot (if any)
        slot4FilterValue:
          type: array
          items:
            type: string
          title: slot4_filter_value
          description: values for each slot (if any)
        slot5FilterValue:
          type: array
          items:
            type: string
          title: slot5_filter_value
          description: values for each slot (if any)
        slot6FilterValue:
          type: array
          items:
            type: string
          title: slot6_filter_value
          description: values for each slot (if any)
        slot7FilterValue:
          type: array
          items:
            type: string
          title: slot7_filter_value
          description: values for each slot (if any)
        slot8FilterValue:
          type: array
          items:
            type: string
          title: slot8_filter_value
          description: values for each slot (if any)
        slot9FilterValue:
          type: array
          items:
            type: string
          title: slot9_filter_value
          description: values for each slot (if any)
        slot10FilterValue:
          type: array
          items:
            type: string
          title: slot10_filter_value
          description: values for each slot (if any)
      title: Item
      additionalProperties: false
      description: search reult item
    connect.error_details.Any:
      type: object
      properties:
        type:
          type: string
          description: >-
            A URL that acts as a globally unique identifier for the type of the
            serialized message. For example:
            `type.googleapis.com/google.rpc.ErrorInfo`.
        value:
          type: string
          format: binary
          description: >-
            The Protobuf message, serialized as bytes and base64-encoded. The
            specific message type is identified by the `type` field.
        debug:
          type: object
          title: Debug
          additionalProperties: true
          description: >-
            Deserialized error detail payload. The 'type' field indicates the
            schema. This field is for easier debugging and should not be relied
            upon for application logic.
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message, with an additional debug
        field for ConnectRPC error details.
    rpc.v1.Member:
      type: object
      properties:
        givenName:
          type:
            - string
            - 'null'
          title: given_name
          description: first name of the user
        familyName:
          type:
            - string
            - 'null'
          title: family_name
          description: last name of the user
        primaryEmail:
          type: string
          title: primary_email
          description: primary email
      title: Member
      additionalProperties: false
      description: assigned member
    rpc.v1.LinkedCrewRequestPositionWithJobPosting:
      type: object
      properties:
        id:
          type: string
          title: id
          format: uuid
          description: id of a linked crew request
        title:
          type: string
          title: title
          description: title of a linked crew request
        state:
          allOf:
            - $ref: '#/components/schemas/rpc.v1.JobPostingState'
          title: state
          description: title of a linked crew request
        position:
          allOf:
            - $ref: >-
                #/components/schemas/rpc.v1.LinkedCrewRequestPositionWithJobPosting.Position
          title: position
          description: linked a position with crew request
      title: LinkedCrewRequestPositionWithJobPosting
      additionalProperties: false
      description: crew request item
    google.protobuf.Timestamp:
      type: string
      examples:
        - '2023-01-15T01:30:15.01Z'
        - '2024-12-25T12:00:00Z'
      format: date-time
      description: >-
        A point in time in RFC 3339 format, with up to nanosecond precision.
        Output uses UTC (`Z`); input may use an offset from UTC.
    rpc.v1.LinkedCrewRequestPositionWithJobPosting.Position:
      type: object
      properties:
        id:
          type: string
          title: id
          format: uuid
          description: id a position
        name:
          type: string
          title: name
          description: name of the position
        nbPositions:
          type: string
          title: nb_positions
          format: int64
          description: amount of positions
      title: Position
      additionalProperties: false
      description: position item
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'Personal API key, sent as `Authorization: Bearer <key>`.'

````