Related
Records linked to this one
Return the ids of records of another type that are linked to this record. Links resolve by identifier, strongest identifier first, and equally-trusted identifiers are combined — a company's linked loans cover every role it holds on a loan, not just the first one found. The response reports which strength was used: primary is the canonical identifier for that pair, secondary is a real but weaker alternate used only when the record carries nothing better. This is a lightweight index: it returns ids and a count, not full records. For filtering, sorting, pagination and full detail, use the named endpoint for the pair (for example the originator loans endpoint) and fetch records by id.
Authorization
Path parameters
idstringrequiredSale id
Query parameters
toenumrequiredType of record to link to
agentsloanspropertieslimitintegerMaximum ids to return (default 25, max 200)
Responses
200objectLinked record idsShow attributesHide attributes
dataobject[]requiredIds of the linked records (unordered)
Show child attributesHide child attributes
idstringrequiredId of the linked record, on the to entity
fromstringrequiredType of the starting record
linkQualityenum | nullrequiredHow the link was established. primary = the canonical identifier for this pair. secondary = a weaker but real alternate identifier, used only because the record carried nothing better. null = the record carries no linking identifier at all, so nothing was searched.
primarysecondarynulltostringrequiredType of the linked records
totalnumberrequiredTotal linked records, before the limit page
400objectValidation error401objectUnauthorized403objectForbidden (authenticated, but missing required context — e.g. no active organization)404objectRecord not found413objectResponse payload too large — detail endpoint capped to fit Lambda response limits503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.