List or search your book of insureds

GET

/broker/insureds

const url = 'https://api.hedgespecialty.com/api/v1/broker/insureds?limit=10&offset=0&include_stats=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.hedgespecialty.com/api/v1/broker/insureds?limit=10&offset=0&include_stats=false' \
  --header 'Authorization: Bearer <token>'

Your brokerage’s insureds on file with Hedge, most recently active first. With q it is the “start from existing insured” picker: returns enough identity to prefill a new submission (name, entity type, contact details, NAICS, mailing address). Pass a matching row’s id as insured_id on submission create to link the account. With include_stats=true each row also carries submissions_count, policies_count and last_activity_at for a book overview.

Authorizations

brokerOAuth

Parameters

Query Parameters

string

Case-insensitive match on the insured name.

limit

integer

default: 10 >= 1 <= 200

offset

integer

Rows to skip, for paging large books.

include_stats

boolean

Adds submissions_count, policies_count and last_activity_at per row (extra aggregate queries; leave off for typeahead use).

Responses

200

Insured summaries