Skip to main content
GET
List document requests

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"

candidate_id
string<uuid>

Only the requests of this candidate (profile_interview.id).

status
enum<string>

Only open, completed or cancelled requests.

Available options:
open,
completed,
cancelled
attention
enum<string>
default:false

true: only your own requests that need you (received or overdue), as To do > Today shows them.

Available options:
true,
false
Example:

"false"

limit
integer
default:50

Requests per page (1 to 200, default 50).

Required range: 1 <= x <= 200
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

One page of document requests.

data
object[]
required

Document requests of this page, newest first (attention: most recent event first).

pagination
object
required