Skip to main content
POST
SearchCrewProfiles

Authorizations

Authorization
string
header
required

Personal API key, sent as Authorization: Bearer <key>.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json

search request

organizationId
string<uuid>

id of the organization in which job postings will be searched.

query
string

query to search for

Maximum string length: 128
page
string<int64>

page of search results to return

perPage
string<int64>

nr of items per page

conversationMode
boolean
deprecated

set this to true to enable conversation mode

enable_hybrid_search will make searching smarter by understanding meaning, but it is slower.

hybrid search is enabled by default, it can be toggled off.

appliedToJobPostingId
string<uuid> | null

only show crew that have applied to a certain job posting

filterByNationalities
string[]

filtering crew profiles by nationality_iso3166_1

Maximum array length: 5
filterByCountriesOfResidence
string[]

filtering crew profiles by country_iso3166_1

Maximum array length: 5
filterByRanks
string[]

filtering crew profiles by ranks (first rank or second rank)

Maximum array length: 5
filterByCertificates
string[]

filtering crew profiles by certificates

Maximum array length: 5
filterByPipelineStageIds
string[]

filtering crew profiles by pipeline stage ids

Maximum array length: 5
includeArchived
boolean

when true, archived crew profiles will be included in search results

enableFlexibleMatchType
boolean | null

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
string[]

filtering crew profiles by crew tag ids

Maximum array length: 5
matchJobPostingId
string<uuid> | null

only show crew matched to a certain job posting

filterByAddedVia
enum<string>[]

filtering crew profiles by how the candidate first entered the system

Maximum array length: 3

EntrySource indicates how a candidate first entered the system, or how a single job application was created.

Available options:
ENTRY_SOURCE_UNSPECIFIED,
ENTRY_SOURCE_CAREER_SITE,
ENTRY_SOURCE_MANUAL,
ENTRY_SOURCE_EMAIL

Response

Success

search response

items
Item · object[]

search results

totalFound
string<int64>

total number of search results

totalPages
string<int64>

total number of pages for all results

currentPage
string<int64>

current page in the search results

conversationAnswer
string | null
deprecated

in the case a conversation search was performed, this field will hold the answer