List Policies

Returns a paginated list of all group health policies associated with your organisation.

Endpoint

GET /v1/policy/

Request

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Query Parameters

Parameter	Type	Required	Description
client_id	string	Yes	Your client/organisation ID
status	string	No	Filter by policy status: POLICY_STATUS_ACTIVE, POLICY_STATUS_INACTIVE, or POLICY_STATUS_SUSPENDED
search	string	No	Search by policy number or insurer name
limit	number	No	Number of results per page (default: 10)
start_cursor	string	No	Cursor for forward pagination (use end_cursor from the previous response)
last_cursor	string	No	Cursor for backward pagination (use start_cursor from the previous response)

Example Request

GET /v1/policy/?client_id=ba_client_abc&status=POLICY_STATUS_ACTIVE&limit=20
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

Success (200 OK)

{
  "payload": {
    "policies": [
      {
        "id": "ba_pol_01k...",
        "client_id": "ba_client_abc...",
        "policy_number": "HLT-2024-00123",
        "insurer_id": "ba_ins_xyz...",
        "product_id": "ba_prod_abc...",
        "tpa_id": "ba_tpa_def...",
        "net_premium": 850000.0,
        "gross_premium": 1003000.0,
        "coverage_type": "COVERAGE_TYPE_ESC",
        "type": "POLICY_TYPE_FAMILY_FLOATER",
        "status": "POLICY_STATUS_ACTIVE",
        "start_date": "2024-01-01",
        "end_date": "2024-12-31",
        "sum_insured": ["300000", "500000"],
        "insurer_name": "Star Health Insurance",
        "insurer_logo": "https://...",
        "product_name": "Comprehensive Health",
        "tpa_name": "Medi Assist",
        "client_name": "Acme Corp"
      }
    ],
    "total_count": 3,
    "start_cursor": "eyJpZCI6...",
    "end_cursor": "eyJpZCI6...",
    "has_previous": false,
    "has_next": false,
    "message": "Policies retrieved successfully",
    "success": true
  }
}

Policy Object Fields

Field	Type	Description
id	string	BizzAssure internal policy ID
client_id	string	Client/organisation this policy belongs to
policy_number	string	Insurer-issued policy number
insurer_id	string	ID of the insurer
product_id	string	ID of the insurance product
tpa_id	string	ID of the Third-Party Administrator
net_premium	number	Net premium amount (INR)
gross_premium	number	Gross premium including taxes (INR)
coverage_type	string	Who is covered — E (Employee only), ES (+Spouse), ESC (+Children), ESCP (+Parents)
type	string	POLICY_TYPE_FAMILY_FLOATER, POLICY_TYPE_INDIVIDUAL, or POLICY_TYPE_FLOATER_WITH_SI_RESTRICTION
status	string	POLICY_STATUS_ACTIVE, POLICY_STATUS_INACTIVE, or POLICY_STATUS_SUSPENDED
start_date	string	Policy start date (YYYY-MM-DD)
end_date	string	Policy end date (YYYY-MM-DD)
insurer_name	string	Display name of the insurer
product_name	string	Display name of the product
tpa_name	string	Display name of the TPA
client_name	string	Display name of the client organisation

Pagination Fields

Field	Type	Description
total_count	number	Total number of policies matching the filter
start_cursor	string	Pass as last_cursor to paginate backward
end_cursor	string	Pass as start_cursor to get the next page
has_previous	boolean	true if there are earlier pages
has_next	boolean	true if there are more pages after this one