Skip to main content
POST
/
sourcing
/
search
Search candidate profiles
curl --request POST \
  --url https://api-service.fribl.co/api/v1/sourcing/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "query": "<string>",
  "options": {
    "high_freshness": true,
    "reveal_emails": true,
    "reveal_phones": true
  },
  "pagination": {
    "limit": 25,
    "offset": 123
  }
}
'
{
  "session_id": "<string>",
  "results": [
    {}
  ],
  "pagination": {
    "total_estimate": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true
  }
}

Authorizations

X-API-KEY
string
header
required

API key in UUID format. Include this header with every authenticated request.

Body

application/json

Request body for searching candidate profiles from external sources.

query
string
required

Natural language search query describing the ideal candidate.

options
object

Search options to control result quality and data exposure.

pagination
object

Pagination settings for the search results.

Response

Search results with candidate profiles.

Response from a sourcing search operation.

session_id
string
required

Session identifier for paginating through these results.

results
object[]
required

Array of candidate profile objects.

pagination
object
required

Pagination metadata for the search results.