Search
K
Contracting & Hierarchies API

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

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

Get one of the calling customer's contract assignment changes by id

Returns a single contract assignment change owned by the calling customer. A change 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 changes.

get

Path Parameters

idstring(uuid)required

The contract assignment change id.

Response

application/json

The contract assignment change.

ContractAssignmentChangeV2

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.

idstring(uuid)required

The contract assignment change id.

contractAssignmentIdstring(uuid)required

The assignment this change applies to.

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).

assignmentStatusIdstring(uuid)

The change’s status.

assignmentStatusNamestring

The human-readable change status (inlined).

newCommissionLevelIdstring(uuid)
newCommissionLevelNamestring

The new commission level name (inlined).

newAnnualizationIdstring(uuid)
contractPacketIdstring(uuid)
taskTypeNamestring

The task type intended by this change.

displayNumberstringrequired

The human-readable change number.

writingNumberstring
effectiveOnstring(date)

The assignment’s contractual effective date (yyyy-MM-dd).

expiresOnstring(date)

The assignment’s contractual expiration date (yyyy-MM-dd).

snapshotStartOnstring(date)

Start of the window this change represented the assignment’s state (yyyy-MM-dd).

snapshotEndOnstring(date)

End of the window this change represented the assignment’s state (yyyy-MM-dd).

referralCodesarray[string]
titlestring
externalNotesstring
uplineContractAssignmentChangeobject

Identity of the change’s upline change, 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

Assigned Resources

Read the carriers, products and commission levels assigned to your account, so your configuration can be retrieved in one call per resource.

List the carriers assigned to the calling customer

Returns the carriers assigned to the calling customer’s account as a token-paginated
collection, so the customer’s configuration can be read in one call. Each carrier carries its
type and status names inline. Results are scoped to the caller; another customer’s carriers are
never returned.
Note: updated_since filters on the carrier organization’s own updatedAt and does not reflect
assignment-only changes if the carrier record itself did not change.

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

A page of assigned carriers.

AssignedCarrierV2Page

A token-paginated page of assigned carriers (plain envelope, no HAL wrappers).

itemsarray[object]required

A carrier assigned to the calling customer’s account.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
 
application/json