Skip to main content
GET
List candidates

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

tab
enum<string>

Filter candidates by recent activity. Omit (or empty) to include all.

Available options:
interview,
pre-screening,
no-action,
leads,
Example:

"interview"

source
enum<string>

Filter by how the candidate entered: invited or self-registered. Omit for both.

Available options:
invited,
registered
Example:

"registered"

order_by
enum<string>
default:created_at_newest

Sort order of the result set.

Available options:
name_accending,
name_decending,
created_at_newest,
created_at_oldest
Example:

"created_at_newest"

filter_text
string

Case-insensitive search on candidate name or email.

filter_emoji
string

Filter by the candidate emoji marker.

limit
integer
default:50

Maximum number of records to return (1–1000).

Required range: 1 <= x <= 1000
Example:

50

offset
integer | null
default:0

Number of records to skip from the start of the result set.

Required range: x >= 0
Example:

0

Response

A page of candidates with pagination metadata.

data
object[]
required

The merchant's candidates for this page.

pagination
object
required