Get Covers

Returns all covers of the customer in JSON according to filters defined in the query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This method allows you to retrieve a list of all the coverages that are associated with your account in JSON format.

This will include a complete list of every coverage, including quotes that have not be activated.

The list can be filtered based on the following parameters

  • Page: Current page to use for pagination of results. Page numbers start at 0.

The following filters are not yet implemented but will be available in a future update:

  • Status: filter based on a specific status (e.g., "pending" will list all coverages that have not yet been activated or rejected)
  • From: filter coverages starting from this date, supplied as an ISO 8601 timestamp
  • To: filter coverages up to this date, supplied as an ISO 8601 timestamp

Use the By ID API to retrieve information on the buyer and seller.

Query Params
string

The status to filter against. Values are "Pending", "Activated", "Settled", "Claimed, "Cancelled", "Expired" and "Rejected"

date

An ISO 8601 datestamp indicating the start date to filter against

date

An ISO 8601 datestamp indicating the end date to filter against

int32

The page number to return, if there are more than 50 results

int32

Number of covers to be returned by page. By default 100 covers are returned and this is the maximum.

string

Covers can be sorted by "dueDate" or "quotedAt" dates

string

Sorting order for the date to sort by. "asc" for ascending and "desc" for descending.

string

The EHID of the buyer.

string

The EHID of the seller.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json