API Reference

Download Insurance Report

get
https://example.com/insurance/export

Returns a report of insurance coverages for carriers in the authenticated user's network, optionally filtered to coverages expiring within a given number of days.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to xlsx

The file format to export. Defaults to xlsx.

Allowed:
integer
≥ 1

Optional upcoming-expiration window, in days. When provided, only coverages expiring between today and this many days from now are returned. Omit to return all coverages.

coverage_types
array of strings

Filter results to one or more coverage types. Omit (or select "All Coverages" in the UI) to include every coverage type.

coverage_types
integer
≥ 1
Defaults to 1

The page of data to retrieve.

integer
1 to 250
Defaults to 10

The number of items per page.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/octet-stream
application/json

Updated about 2 hours ago

Did this page help you?