> ## 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. # ListMatchedCandidatesForJobPosting > List candidates that have been matched against a job posting, ordered by score DESC. Pure DB read against job_posting_candidate_matches. ## OpenAPI ````yaml https://edge.test.sterndesk.com/api/openapi.yaml post /rpc/rpc.v1.OrganizationService/ListMatchedCandidatesForJobPosting 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 ` 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 `. 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/ListMatchedCandidatesForJobPosting: post: tags: - rpc.v1.OrganizationService summary: ListMatchedCandidatesForJobPosting description: >- List candidates that have been matched against a job posting, ordered by score DESC. Pure DB read against job_posting_candidate_matches. operationId: rpc.v1.OrganizationService.ListMatchedCandidatesForJobPosting 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.ListMatchedCandidatesForJobPostingRequest required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/rpc.v1.ListMatchedCandidatesForJobPostingResponse 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.ListMatchedCandidatesForJobPostingRequest: type: object properties: jobPostingId: type: string title: job_posting_id format: uuid description: id of the job posting paging: allOf: - $ref: '#/components/schemas/rpc.v1.PagingRequest' title: paging description: describes how the client would like to have pagination title: ListMatchedCandidatesForJobPostingRequest additionalProperties: false description: request to list candidates matched to a job posting rpc.v1.ListMatchedCandidatesForJobPostingResponse: type: object properties: items: type: array items: $ref: >- #/components/schemas/rpc.v1.ListMatchedCandidatesForJobPostingResponse.Item title: items description: items of matched candidates ordered by score DESC paging: allOf: - $ref: '#/components/schemas/rpc.v1.PagingResponse' title: paging description: paging information from the server. title: ListMatchedCandidatesForJobPostingResponse additionalProperties: false description: response with the list of matched candidates 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.PagingRequest: type: object properties: size: allOf: - $ref: '#/components/schemas/rpc.v1.PagingSize' title: size description: size of the page afterCursor: type: - string - 'null' title: after_cursor maxLength: 128 minLength: 1 description: cursor for pagination the next page beforeCursor: type: - string - 'null' title: before_cursor maxLength: 128 minLength: 1 description: cursor for pagination the previous page title: PagingRequest additionalProperties: false description: describe the paging request for the server rpc.v1.ListMatchedCandidatesForJobPostingResponse.Item: type: object properties: id: type: string title: id description: id of the match row crewProfileId: type: string title: crew_profile_id description: id of the crew profile this match is for givenName: type: - string - 'null' title: given_name description: given (first) name of the candidate familyName: type: - string - 'null' title: family_name description: family (last) name of the candidate primaryEmail: type: string title: primary_email description: primary email of the candidate score: type: integer title: score format: int32 description: overall match score (0-100) breakdown: type: object title: breakdown additionalProperties: type: number title: value format: double description: >- per-criterion contribution to the score (e.g., {"rank": 1.0, "vessel": 0.5, "experience": 0.8}) computedAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: computed_at description: when the score was computed matchedRank: type: - string - 'null' title: matched_rank description: rank evidence that qualified this candidate for the posting matchedVesselType: type: - string - 'null' title: matched_vessel_type description: vessel type evidence that qualified this candidate for the posting qualifyingExperienceMonths: type: integer title: qualifying_experience_months format: int32 description: >- uncapped qualifying experience in the matched rank and vessel type, in months requiredExperienceMonths: type: - integer - 'null' title: required_experience_months format: int32 description: >- positive required experience in months, absent when the posting does not specify it certificateCount: type: integer title: certificate_count format: int32 description: >- all regular and STCW certificate extraction records, counted once each regardless of validity requiredCertificates: type: array items: type: string title: required_certificates description: >- certificate codes required by the posting; empty when none are specified alreadyApplied: type: boolean title: already_applied description: >- whether an application already exists under the standard duplicate semantics faceImage: allOf: - $ref: '#/components/schemas/rpc.v1.DocumentExtraction' title: face_image description: most recent extracted candidate face image, absent when unavailable confirmedRelevantMonths: type: - integer - 'null' title: confirmed_relevant_months minimum: 0 format: int32 description: confirmed experience for the required rank and vessel type possibleRelevantMonths: type: - integer - 'null' title: possible_relevant_months minimum: 0 format: int32 description: possible experience including ambiguous two-rank records vesselTypeRelevantMonths: type: - integer - 'null' title: vessel_type_relevant_months minimum: 0 format: int32 description: experience for the required vessel type when no rank is required containsEstimatedMonths: type: - boolean - 'null' title: contains_estimated_months description: >- whether estimated date boundaries add months to the scoring experience title: Item additionalProperties: false description: item of a matched candidate rpc.v1.PagingResponse: type: object properties: nextCursor: type: - string - 'null' title: next_cursor description: cursor to the next page previousCursor: type: - string - 'null' title: previous_cursor description: cursor to the previous page title: PagingResponse additionalProperties: false description: describe the paginge status from the server 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.PagingSize: type: string title: PagingSize enum: - PAGING_SIZE_UNSPECIFIED - PAGING_SIZE_2 - PAGING_SIZE_20 - PAGING_SIZE_100 - PAGING_SIZE_200 - PAGING_SIZE_1 - PAGING_SIZE_5 description: how many per page 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.DocumentExtraction: type: object anyOf: - type: object properties: atSeaWorkExperienceId: type: string title: at_sea_work_experience_id description: At-sea work experience ID title: at_sea_work_experience_id - type: object properties: countryOfResidenceIso31661: type: string title: country_of_residence_iso3166_1 description: country of residence value title: country_of_residence_iso3166_1 - type: object properties: dateOfBirth: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: date_of_birth description: date of birth value title: date_of_birth - type: object properties: faceImageUrl: type: string title: face_image_url description: face image url title: face_image_url - type: object properties: nationalityIso31661: type: string title: nationality_iso3166_1 description: nationality value title: nationality_iso3166_1 - type: object properties: onLandWorkExperienceId: type: string title: on_land_work_experience_id description: id of the on land work experience item title: on_land_work_experience_id unevaluatedProperties: false not: allOf: - anyOf: - required: - atSeaWorkExperienceId - required: - countryOfResidenceIso31661 - required: - dateOfBirth - required: - faceImageUrl - required: - nationalityIso31661 - required: - onLandWorkExperienceId - not: oneOf: - required: - atSeaWorkExperienceId - required: - countryOfResidenceIso31661 - required: - dateOfBirth - required: - faceImageUrl - required: - nationalityIso31661 - required: - onLandWorkExperienceId properties: documentSetId: type: string title: document_set_id description: id of the document set the document extraction is from documentId: type: string title: document_id description: id of the document the extraction is from pageIndex: type: string title: page_index format: int64 description: index of the page the extraction is from kind: allOf: - $ref: '#/components/schemas/rpc.v1.DocumentExtractionKind' title: kind description: the kind of data that was extracted kindSequence: type: string title: kind_sequence format: int64 description: >- if the kind can occure multiple times this provides an unique sequence. reasoning: type: array items: type: string title: reasoning description: any reasoning that the AI performed to extract the data. snippet: type: string title: snippet description: the exact piece of the document that the LLM quotes as the source. createdAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: when the extraction was created updatedAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at description: when the extraction was updated title: DocumentExtraction description: >- Document extraction describes a piece of information extracted from a document. rpc.v1.DocumentExtractionKind: type: string title: DocumentExtractionKind enum: - DOCUMENT_EXTRACTION_KIND_UNSPECIFIED - DOCUMENT_EXTRACTION_KIND_DATE_OF_BIRTH - DOCUMENT_EXTRACTION_KIND_NATIONALITY - DOCUMENT_EXTRACTION_KIND_COUNTRY_OF_RESIDENCE - DOCUMENT_EXTRACTION_KIND_ON_LAND_WORK_EXPERIENCE - DOCUMENT_EXTRACTION_KIND_AT_SEA_WORK_EXPERIENCE - DOCUMENT_EXTRACTION_KIND_CERTIFICATE - DOCUMENT_EXTRACTION_KIND_STCW_CERTIFICATE - DOCUMENT_EXTRACTION_KIND_FACE_IMAGE description: Different kinds of information that can be extracted from a document securitySchemes: apiKey: type: http scheme: bearer description: 'Personal API key, sent as `Authorization: Bearer `.' ````