Contracting & Hierarchies API
Contract Assignments
Read contract assignments: a producer’s placement against a carrier’s product.
List the calling customer's contract assignments
Returns the contract assignments sent from the calling customer’s organization as a
token-paginated collection. Results are scoped to the caller; another customer’s assignments
are never returned.
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
updated_sincestring(date-time)
Return only contracts modified at or after this RFC3339 UTC timestamp (inclusive). Modified
time tracks any column change, so “modified” does not necessarily mean a
business-meaningful change. Best used as a high-water mark for incremental sync: a pagination
run is not a point-in-time snapshot, so records updated mid-run may first appear on a later poll.
Example:2026-06-01T00:00:00Z
Response
application/json
Response
application/json
A page of contract assignments.
ContractAssignmentV2Page
A token-paginated page of contract assignments (plain envelope, no HAL wrappers).
itemsarray[object]required
A producer’s assignment to a carrier product, with its commission level and status.
Show Child Parameters
pageobjectrequired
Pagination metadata for a V2 list response.
Show Child Parameters
application/json
Get one of the calling customer's contract assignments by id
Returns a single contract assignment owned by the calling customer. An assignment that does
not exist or belongs to another customer returns 404 (never 403), so the endpoint does not
reveal the existence of out-of-scope assignments.
get
Path Parameters
idstring(uuid)required
The contract assignment id.
Response
application/json
Response
application/json
The contract assignment.
ContractAssignmentV2
A producer’s assignment to a carrier product, with its commission level and status.
idstring(uuid)required
The contract assignment id.
contractIdstring(uuid)required
The parent contract id.
agencyOrganizationIdstring(uuid)required
The agency organization the assignment is sent from.
carrierOrganizationIdstring(uuid)required
The carrier organization the assignment is sent to.
personIdstring(uuid)required
The individual producer the assignment is on behalf of.
firmIdstring(uuid)
The firm the assignment is on behalf of, if any.
productIdstring(uuid)required
productNamestring
The product name (inlined so no follow-up lookup is needed).
commissionLevelIdstring(uuid)required
commissionLevelNamestring
The commission level name (inlined).
assignmentStatusIdstring(uuid)
assignmentStatusNamestring
The human-readable assignment status (the event names this assignmentStatus).
displayNumberstringrequired
The human-readable assignment number.
writingNumberstring
effectiveOnstring(date)
The effective date (yyyy-MM-dd).
requestedEffectiveOnstring(date)
The requested effective date (yyyy-MM-dd).
expiresOnstring(date)
The expiration date (yyyy-MM-dd). Renamed from the entity’s expiry.
responsiblePartyIdstring(uuid)
responsibleUplineFirmIdstring(uuid)
responsiblePartyStartOnstring(date)
responsiblePartyEndOnstring(date)
referralCodesarray[string]
debitBalancenumber
externalNotesstring
uplineContractAssignmentobject
Identity of the assignment’s upline, surfaced as part of the caller’s own hierarchy.
Show Child Parameters
createdAtstring(date-time)
RFC3339 UTC creation timestamp.
updatedAtstring(date-time)
RFC3339 UTC last-modified timestamp.
userDefined1string
userDefined2string
userDefined3string
userDefined4string
userDefined5string
userDefined6string
userDefined7string
userDefined8string
userDefined9string
userDefined10string
application/json
Assignment Changes
Read contract assignment changes - point-in-time snapshots of an assignment carrying the before/after status pair explicitly.
List the calling customer's contract assignment changes
Returns the contract assignment changes for the calling customer’s organization as a
token-paginated collection. A change is a point-in-time snapshot of an assignment and carries
the before/after status pair explicitly. Results are scoped to the caller; another customer’s
changes are never returned.
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
updated_sincestring(date-time)
Return only contracts modified at or after this RFC3339 UTC timestamp (inclusive). Modified
time tracks any column change, so “modified” does not necessarily mean a
business-meaningful change. Best used as a high-water mark for incremental sync: a pagination
run is not a point-in-time snapshot, so records updated mid-run may first appear on a later poll.
Example:2026-06-01T00:00:00Z
Response
application/json
Response
application/json
A page of contract assignment changes.
ContractAssignmentChangeV2Page
A token-paginated page of contract assignment changes (plain envelope, no HAL wrappers).
itemsarray[object]required
A point-in-time change to a contract assignment. assignmentStatus* is the change’s own
status. effectiveOn/expiresOn are the assignment’s contractual terms, while
snapshotStartOn/snapshotEndOn are the window during which this change represented the
assignment’s state.
Show Child Parameters
pageobjectrequired
Pagination metadata for a V2 list response.
Show Child Parameters
application/json