Contracting & Hierarchies API
List the firms responsible for upline relationships in an organization
Returns the firms referenced as the responsible upline firm by at least one of the
organization’s contract assignments, as a token-paginated collection. The organization
lookup is scoped to the caller’s organization(s), so an unknown or out-of-scope
organization returns 404. Optionally narrowed with as_of to firms with a referencing
assignment whose approved commission-terms window covers a given date.
get
Query Parameters
page_tokenstring
Opaque continuation token from a previous response’s page.nextToken. Omit for the first
page.
page_sizeinteger
Maximum number of items to return. Defaults to 25; values outside [1, 250] are rejected
with 400 (not clamped).
Default:25
>= 1<= 250
as_ofstring(date)
Narrow results to candidates whose current commission-terms window covers this date
(inclusive). Omit to return all eligible candidates regardless of window.
Example:2026-06-22
Path Parameters
organizationIdstring(uuid)required
The organization whose responsible upline firms to list.
Response
application/json
Response
application/json
A page of responsible upline firms.
ResponsibleUplineFirmV2Page
A token-paginated page of responsible upline firms (plain envelope, no HAL wrappers).
itemsarray[object]required
A firm responsible for upline relationships in an organization.
Show Child Parameters
pageobjectrequired
Pagination metadata for a V2 list response.
Show Child Parameters
application/json
Webhook Events
Outbound events delivered to your configured endpoint when contracts, contract assignments, or hierarchy placements change.
contractProducerStatusUpdated
WEBHOOKDelivered when a producer’s role status is created or updated within an
organization. Fires on both the initial assignment of a status and any
subsequent change.
The data.organizationId field identifies the agency or carrier
organization whose producer hierarchy was affected.
post
Body
application/json
Body
application/json
ProducerStatusUpdatedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Payload for the contract.producer_status.updated event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
contractAssignmentUpdated
WEBHOOKDelivered when a contract assignment is created or updated. This event
fires for both new assignments and any modification to an existing
assignment (status change, commission level change, writing number
assignment, etc.).
The data.agencyOrganizationId identifies the agency that owns the
assignment. The data.contractAssignmentId is stable across updates
and can be used to correlate events for the same record.
post
Body
application/json
Body
application/json
ContractAssignmentUpdatedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Payload for the contract.assignment.updated event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
contractAssignmentDeleted
WEBHOOKDelivered when a contract assignment is permanently deleted. After this
event, the contractAssignmentId will no longer exist in the system.
Only the contractAssignmentId and displayNumber are included because
no other state is meaningful once the record is gone.
post
Body
application/json
Body
application/json
ContractAssignmentDeletedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Payload for the contract.assignment.deleted event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200