Returns the currently-approved contract assignments eligible to be selected as another
contract assignment’s upline, scoped to a specific organization and product, as a
token-paginated collection. Optionally narrowed with as_of to candidates whose current
commission-terms window covers a given date.
Opaque continuation token from a previous response’s page.nextToken. Omit for the first
page.
Maximum number of items to return. Defaults to 25; values outside [1, 250] are rejected
with 400 (not clamped).
Default:25
>= 1<= 250
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
The organization to find available uplines for.
The product to find available uplines for.
A page of available upline candidates.
A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).
A currently-approved contract assignment eligible to be selected as an upline.
Pagination metadata for a V2 list response.
Returns the currently-approved firm contract assignments eligible to be selected as the
responsible upline firm for the given contract assignment, as a token-paginated collection.
Candidates are drawn from the assignment’s organization and product, restricted to firms,
and — when the assignment’s producer belongs to organization divisions — to candidates in
those divisions. Results are scoped to the caller’s organization(s). Optionally narrowed
with as_of to candidates whose current commission-terms window covers a given date.
Opaque continuation token from a previous response’s page.nextToken. Omit for the first
page.
Maximum number of items to return. Defaults to 25; values outside [1, 250] are rejected
with 400 (not clamped).
Default:25
>= 1<= 250
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
The contract assignment to find available upline firms for.
A page of available upline firm candidates.
A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).
A currently-approved contract assignment eligible to be selected as an upline.
Pagination metadata for a V2 list response.
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.
Opaque continuation token from a previous response’s page.nextToken. Omit for the first
page.
Maximum number of items to return. Defaults to 25; values outside [1, 250] are rejected
with 400 (not clamped).
Default:25
>= 1<= 250
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
The organization whose responsible upline firms to list.
A page of responsible upline firms.
A token-paginated page of responsible upline firms (plain envelope, no HAL wrappers).
A firm responsible for upline relationships in an organization.
Pagination metadata for a V2 list response.
Outbound events delivered to your configured endpoint when contracts, contract assignments, or hierarchy placements change.
Delivered 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.
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
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
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
Payload for the contract.producer_status.updated event.
Customer endpoint acknowledged the event.