Skip to main content
Brokers are individual agents or producers associated with a brokerage. The Brokers API allows you to programmatically create, read, update, and delete broker information within your company. Key Concepts:
  • Brokers are individual agents who work under a brokerage
  • Each broker must be associated with an existing brokerage via brokerageId
  • Brokers can have their own contact information, commission percentage, and producer number
  • A broker may optionally have an associated user ID for portal access

​
API Endpoints

​
Broker vs Brokerage

EntityDescription
BrokerageAn insurance agency or broker organization (company level)
BrokerAn individual agent/producer who works for a brokerage (person level)
A brokerage can have multiple brokers, but each broker belongs to exactly one brokerage.

​
Structured Address

The addressStructured field contains a structured address object with the following fields:
FieldTypeDescription
line1stringStreet address line 1
line2stringStreet address line 2 (optional)
citystringCity
statestringState or province
zipstringZIP or postal code
countrystringCountry code

​
Nullable Fields

The following fields may be null in the response:
FieldWhen null
emailEmail not provided
phonePhone number not provided
workPhoneWork phone not provided
addressStructuredAddress not provided
defaultCommissionPercentageDefault commission not configured
producerNumberProducer number not assigned
userIdBroker does not have portal access
createdAtTimestamp not tracked (legacy records)
createdByCreated by system or unknown user
updatedAtBroker has never been updated
updatedByNever updated or updated by system

​
Filtering and Sorting

List endpoints support comprehensive filtering and sorting options:

​
Filter Parameters

ParameterTypeDescription
idstring or arrayFilter by specific broker ID(s)
brokerageIdstringFilter by brokerage ID
filterTextstringText search across broker name

​
Sorting Parameters

ParameterTypeDefaultDescription
sortBystringcreatedAtField to sort by (createdAt, updatedAt, name, email, defaultCommissionPercentage)
sortDirectionstringdescSort direction (asc or desc)

​
Pagination

ParameterTypeDefaultDescription
pageinteger1Page number (1-based, page size 50)
Response includes:
  • items - Array of brokers for the current page
  • totalCount - Total number of matching brokers across all pages

​
Permissions

Access to brokers requires the appropriate permissions based on your API key:
OperationRequired Permission
List Brokerscompany.broker:read
Get Brokerbroker:read
Create Brokercompany.broker:create
Update Brokerbroker:update
Delete Brokercompany.broker:create

​
Example Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "companyId": "660e8400-e29b-41d4-a716-446655440000",
      "brokerageId": "770e8400-e29b-41d4-a716-446655440000",
      "name": "John Smith",
      "email": "[email protected]",
      "phone": "+1-555-123-4567",
      "workPhone": "+1-555-123-4568",
      "addressStructured": {
        "line1": "123 Main Street",
        "line2": "Suite 100",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US"
      },
      "defaultCommissionPercentage": 15,
      "producerNumber": "PRD-12345",
      "userId": null,
      "createdAt": "2025-01-15T10:30:00.000Z",
      "createdBy": "880e8400-e29b-41d4-a716-446655440000",
      "updatedAt": "2025-01-16T14:20:00.000Z",
      "updatedBy": "880e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "totalCount": 42
}