> ## 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. # SearchCrewProfiles > Search crew profiles ## OpenAPI ````yaml https://edge.test.sterndesk.com/api/openapi.yaml post /rpc/rpc.v1.OrganizationService/SearchCrewProfiles 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/SearchCrewProfiles: post: tags: - rpc.v1.OrganizationService summary: SearchCrewProfiles description: Search crew profiles operationId: rpc.v1.OrganizationService.SearchCrewProfiles 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.SearchCrewProfilesRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/rpc.v1.SearchCrewProfilesResponse' 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.SearchCrewProfilesRequest: type: object properties: organizationId: type: string title: organization_id format: uuid description: id of the organization in which job postings will be searched. query: type: string title: query maxLength: 128 description: query to search for page: type: string title: page minimum: 1 format: int64 description: page of search results to return perPage: type: string title: per_page minimum: 1 format: int64 description: nr of items per page conversationMode: type: boolean title: conversation_mode description: set this to true to enable conversation mode deprecated: true enableHybridSearch: type: boolean title: enable_hybrid_search description: >- enable_hybrid_search will make searching smarter by understanding meaning, but it is slower. deprecated: true disableHybridSearch: type: boolean title: disable_hybrid_search description: hybrid search is enabled by default, it can be toggled off. appliedToJobPostingId: type: - string - 'null' title: applied_to_job_posting_id format: uuid description: only show crew that have applied to a certain job posting filterByNationalities: type: array items: type: string title: filter_by_nationalities maxItems: 5 description: filtering crew profiles by nationality_iso3166_1 filterByCountriesOfResidence: type: array items: type: string title: filter_by_countries_of_residence maxItems: 5 description: filtering crew profiles by country_iso3166_1 filterByRanks: type: array items: type: string title: filter_by_ranks maxItems: 5 description: filtering crew profiles by ranks (first rank or second rank) filterByCertificates: type: array items: type: string title: filter_by_certificates maxItems: 5 description: filtering crew profiles by certificates filterByPipelineStageIds: type: array items: type: string title: filter_by_pipeline_stage_ids maxItems: 5 description: filtering crew profiles by pipeline stage ids includeArchived: type: boolean title: include_archived description: when true, archived crew profiles will be included in search results enableFlexibleMatchType: type: - boolean - 'null' title: enable_flexible_match_type description: |- when enabled, applies relaxed boolean logic to filters. switches from strict conjunctive matching (AND across filter groups) to a more permissive mode allowing disjunctive matches (OR between groups). filterByCrewTagIds: type: array items: type: string title: filter_by_crew_tag_ids maxItems: 5 description: filtering crew profiles by crew tag ids matchJobPostingId: type: - string - 'null' title: match_job_posting_id format: uuid description: only show crew matched to a certain job posting filterByAddedVia: type: array items: $ref: '#/components/schemas/rpc.v1.EntrySource' title: filter_by_added_via maxItems: 3 uniqueItems: true description: >- filtering crew profiles by how the candidate first entered the system title: SearchCrewProfilesRequest additionalProperties: false description: search request rpc.v1.SearchCrewProfilesResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/rpc.v1.SearchCrewProfilesResponse.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 conversationAnswer: type: - string - 'null' title: conversation_answer description: >- in the case a conversation search was performed, this field will hold the answer deprecated: true title: SearchCrewProfilesResponse additionalProperties: false description: search response 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.EntrySource: type: string title: EntrySource enum: - ENTRY_SOURCE_UNSPECIFIED - ENTRY_SOURCE_CAREER_SITE - ENTRY_SOURCE_MANUAL - ENTRY_SOURCE_EMAIL description: >- EntrySource indicates how a candidate first entered the system, or how a single job application was created. rpc.v1.SearchCrewProfilesResponse.Item: type: object properties: id: type: string title: id description: id of the job posting organizationId: type: string title: organization_id description: id of the organization. primaryEmail: type: string title: primary_email description: primary email of the crew profile givenName: type: - string - 'null' title: given_name description: given name, if any familyName: type: - string - 'null' title: family_name description: family name, if any highlights: allOf: - $ref: >- #/components/schemas/rpc.v1.SearchCrewProfilesResponse.ItemHighlights title: highlights description: any highlights from the search engine primaryPhoneE164: type: - string - 'null' title: primary_phone_e164 description: primary phone number in E.164 format, if known addedVia: allOf: - $ref: '#/components/schemas/rpc.v1.EntrySource' title: added_via description: >- how this candidate first entered the system: career site, manual, or email createdAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: timestamp when the profile was created dateOfBirth: allOf: - $ref: '#/components/schemas/rpc.v1.DocumentExtraction' title: date_of_birth description: extracted date of birth countryOfResidence: allOf: - $ref: '#/components/schemas/rpc.v1.DocumentExtraction' title: country_of_residence description: extracted country of residence nationality: allOf: - $ref: '#/components/schemas/rpc.v1.DocumentExtraction' title: nationality description: extracted nationality faceImage: allOf: - $ref: '#/components/schemas/rpc.v1.DocumentExtraction' title: face_image description: image of the face, if extracted documentSetCount: type: string title: document_set_count format: int64 description: count of the nr of document sets this profile has isArchived: type: boolean title: is_archived description: whether the crew profile is archived archivedAt: oneOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' - type: 'null' title: archived_at description: timestamp when the profile was archived proposalIds: type: array items: type: string title: proposal_ids description: ids of the proposals this crew profile is already part of source: allOf: - $ref: '#/components/schemas/rpc.v1.EntrySource' title: source description: how this candidate first entered the system sourceId: type: - string - 'null' title: source_id description: >- id of the originating record: job application, email receipt or manual upload. empty when there is no such record jobPostingMatch: oneOf: - $ref: '#/components/schemas/rpc.v1.JobPostingMatch' - type: 'null' title: job_posting_match description: >- persisted match details for the filtered job posting, absent when unavailable 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.SearchCrewProfilesResponse.ItemHighlights: type: object properties: givenName: oneOf: - $ref: '#/components/schemas/rpc.v1.SearchResultHighlight' - type: 'null' title: given_name description: given name highlight (if any) familyName: oneOf: - $ref: '#/components/schemas/rpc.v1.SearchResultHighlight' - type: 'null' title: family_name description: family name highlight atSeaWorkExperienceSsV2: type: array items: $ref: '#/components/schemas/rpc.v1.SearchResultHighlight' title: at_sea_work_experience_ss_v2 description: work experience at sea highlights certificateSsV1: type: array items: $ref: '#/components/schemas/rpc.v1.SearchResultHighlight' title: certificate_ss_v1 description: certificate highlights title: ItemHighlights additionalProperties: false description: highlighting for each 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.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.JobPostingMatch: type: object properties: matchScore: type: - string - 'null' title: match_score format: int64 description: >- exact persisted score, including zero; absent when scoring is unavailable matchBreakdown: oneOf: - $ref: '#/components/schemas/rpc.v1.JobPostingMatchBreakdown' - type: 'null' title: match_breakdown description: >- typed persisted breakdown; fields are absent when their criterion was not evaluated requiredRank: type: - string - 'null' title: required_rank description: exact rank required by the job posting, absent when unspecified requiredCertificates: type: array items: type: string title: required_certificates description: certificate codes required by the job posting requiredExperienceMonths: type: - string - 'null' title: required_experience_months format: int64 description: positive required experience in months, absent when unspecified qualifyingExperienceMonths: type: string title: qualifying_experience_months format: int64 description: uncapped qualifying experience in months failureReasons: type: array items: type: string title: failure_reasons description: >- distinct persisted hard-check failures; never includes affected certificate codes title: JobPostingMatch additionalProperties: false description: persisted match details for a job posting and crew profile rpc.v1.SearchResultHighlight: type: object properties: snippet: type: string title: snippet description: the snippet of text with the highlight marked in it title: SearchResultHighlight additionalProperties: false description: describes a highlight in a search result 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 rpc.v1.JobPostingMatchBreakdown: type: object properties: vesselType: type: - boolean - 'null' title: vessel_type description: whether the candidate has experience on the required vessel type experience: type: - number - 'null' title: experience maximum: 1 minimum: 0 format: double description: capped qualifying-experience ratio from 0 through 1 experiencePercent: type: - string - 'null' title: experience_percent maximum: 100 minimum: 0 format: int64 description: rounded qualifying-experience percentage from 0 through 100 qualifyingExperienceMonths: type: - string - 'null' title: qualifying_experience_months minimum: 0 format: int64 description: uncapped qualifying experience in whole months confirmedRelevantMonths: type: - string - 'null' title: confirmed_relevant_months minimum: 0 format: int64 description: confirmed experience for the required rank and vessel type possibleRelevantMonths: type: - string - 'null' title: possible_relevant_months minimum: 0 format: int64 description: possible experience including ambiguous two-rank records vesselTypeRelevantMonths: type: - string - 'null' title: vessel_type_relevant_months minimum: 0 format: int64 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 mainVesselType: type: - boolean - 'null' title: main_vessel_type description: >- whether the candidate has experience on a vessel type the posting names as a main requirement similarVesselType: type: - boolean - 'null' title: similar_vessel_type description: >- whether the candidate has experience on a vessel type the posting accepts as an alternative mainRank: type: - boolean - 'null' title: main_rank description: >- whether the candidate holds a rank the posting names as a main requirement similarRank: type: - boolean - 'null' title: similar_rank description: >- whether the candidate holds a rank the posting accepts as an alternative mainRelevantMonths: type: - string - 'null' title: main_relevant_months minimum: 0 format: int64 description: scoring experience served in a main rank on a main vessel type similarRelevantMonths: type: - string - 'null' title: similar_relevant_months minimum: 0 format: int64 description: >- scoring experience served under an alternative rank or vessel type the posting accepts title: JobPostingMatchBreakdown additionalProperties: false description: persisted per-criterion match details securitySchemes: apiKey: type: http scheme: bearer description: 'Personal API key, sent as `Authorization: Bearer `.' ````