Developer API

Connect your stack to the placement record.

HALO IQ exposes a versioned REST API on your tenant: pull CRM and risk data, push updates, and react to webhooks — without screen scraping.

HALO IQ / PLACEMENT MARKETPLACE
What you can build

Pull, push, and subscribe.

01 / CRM

Companies, contacts, and deals

List and sync your pipeline. Create and update organizations, people, and opportunities with scoped API keys.

02 / Proposals

Proposal drafts and status

Read proposal records and create new drafts when your integration starts the sales workflow in HALO.

03 / Placement

Carriers, mod, and claims (read)

Pull workers’ comp carriers, quotes, policies, mod worksheets, and claims for reporting and downstream systems.

04 / Events

Signed webhooks

Subscribe to deal, contact, company, and proposal events. Verify HMAC signatures on every delivery.

05 / Auth

API keys and OAuth

Server-to-server keys for your tenant, or OAuth 2.0 with PKCE when a third-party app acts for a signed-in user.

06 / SDK

TypeScript client

Official @haloiq/sdk package with types generated from our OpenAPI spec — list, create, and handle rate limits.

For brokers

Keys live in Broker Admin.

After you sign in to your agency workspace, open Broker Admin → API & webhooks. Create a key, choose the smallest permission scopes your integration needs, and copy the secret once — it is shown only at creation.

Permission scopes

Least privilege by design.

  • read:companies · write:companies
  • read:contacts · write:contacts
  • read:deals · write:deals
  • read:proposals · write:proposals
  • read:carriers · read:carrier-quotes · read:carrier-policies
  • read:mod-employers · read:mod-worksheets · read:claims
  • read:assessments · read:analytics

Every response uses the same JSON envelope, pagination via limit and offset, and rate limits of 100 requests per minute per key. Full scope tables and webhook catalogs are in the API reference.

Integrations

Need help wiring your AMS or data warehouse?

Talk to us about marketplace seats, parsing, and which modules to enable before you go to production.