candidates

List Candidates

List all candidates for the organization

Args: status_filter: Filter by status ('active', 'hired', 'rejected') search: Search by name or email hiring_company: Filter to candidates with ≥1 interview against a role whose hiring_company_display matches (trim + case- insensitive). Drives the agency-mode "show me Tesco candidates" view. Single value for v1 — multi-select is a Phase 2 question if a customer asks. limit: Maximum results per page offset: Pagination offset

Returns: Paginated list of candidates with interview counts

get/api/candidates/list

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/candidates/list
  • Auth: HTTP bearer

Query parameters

status_filterstring nullable
searchstring nullable
hiring_companystring nullable
mineboolean
limitinteger
offsetinteger

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.