Skip to main content
GET
List verifications of benefits

Authorizations

X-API-Key
string
header
required

Query Parameters

page
integer
default:1

Page number, from 1.

Required range: x >= 1
limit
integer
default:50

Page size, 1-100.

Required range: 1 <= x <= 100
patient_id
string<uuid> | null

Only this patient's VOBs.

patient_policy_id
string<uuid> | null

Only this policy's VOBs.

status
enum<string>[] | null

Only VOBs in these statuses.

VOB status enum matching Prisma exactly.

Available options:
pending,
in_progress,
completed,
missing_information,
cancelled
priority
boolean | null

Only priority (true) or normal (false) VOBs.

include
string | null

result embeds each VOB's result.

Allowed value: "result"

Response

Successful Response

data
VobOut · object[]
required
pagination
Pagination · object
required

Pagination information for list responses.

Fields:

  • has_more: Whether more items exist beyond this page
  • total: Total number of items across all pages
  • page: Current page number (1-based)
  • limit: Number of items per page