Alfa

Search

Search the organisation's candidates, jobs and teammates

POST/v1/search

Set `reranking` to false for type-ahead refinement, where reranking costs more latency than it earns. `filters.jobId` limits candidates to the applicants of that job.

Requires the session token of a signed-in Alfa user as a bearer token.

Request body

  • querystring

    at most 500 characters

  • entityTypes"all" | "candidates" | "jobs" | "users"[]
  • filtersobject
    Show fields
    • statusstring
    • jobIdinteger

      greater than 0

  • pageinteger

    minimum 1

  • limitinteger

    minimum 1 · maximum 100

  • rerankingboolean

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details