Contracting & Hierarchies API
List the candidates eligible to be selected as an upline for a product
Returns the currently-approved contract assignments eligible to be selected as another
contract assignment’s upline for the given product, as a token-paginated collection.
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.
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
productIdstring(uuid)required
The product to find available uplines for.
Response
application/json
Response
application/json
A page of available upline candidates.
AvailableUplineV2Page
A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).
itemsarray[object]required
A currently-approved contract assignment eligible to be selected as an upline.
Show Child Parameters
pageobjectrequired
Pagination metadata for a V2 list response.
Show Child Parameters
application/json
List the candidates eligible to be selected as an upline for an organization's product
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.
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 to find available uplines for.
productIdstring(uuid)required
The product to find available uplines for.
Response
application/json
Response
application/json
A page of available upline candidates.
AvailableUplineV2Page
A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).
itemsarray[object]required
A currently-approved contract assignment eligible to be selected as an upline.
Show Child Parameters
pageobjectrequired
Pagination metadata for a V2 list response.
Show Child Parameters
application/json
List the firm candidates eligible to be the responsible upline for a contract assignment
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.
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
contractAssignmentIdstring(uuid)required
The contract assignment to find available upline firms for.
Response
application/json
Response
application/json
A page of available upline firm candidates.
AvailableUplineV2Page
A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).
itemsarray[object]required
A currently-approved contract assignment eligible to be selected as an upline.
Show Child Parameters
pageobjectrequired
Pagination metadata for a V2 list response.
Show Child Parameters
application/json
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.