Get the relationships of an entity
get_relationshipsThe links of one entity in Atlas, in both directions: the lenders of a company and the borrowers of a bank (with the commitment of each lender under each credit agreement where its schedule proves it), its customers and its suppliers (a supplier is a company whose own annual report names it as a major customer) with the share of revenue, owners and holdings with the interest, collaboration partners and named related parties. Every link gives its summary, the class of its evidence (stated by one party, confirmed by both, or stated by the register of legal entities), each claim with the part of the document that states it, and the documents with their addresses. A covered company also gets the links of the entities of its group (group: true, the default). Probable links are listed apart.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"entity": "<entity>"
},
"name": "get_relationships"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | No | include the links of the entities of the group of a covered company (default true) | |
| kinds | No | kinds of link to return (default every kind) | |
| limit | No | maximum number of links (default 100) | |
| entity | Yes | entity id from search_entities, for example boeing, citigroup or dbs-bank-ltd | |
| direction | No | from: links where the entity lends, sells or owns; to: where it borrows, buys or is owned (default both) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| as_of | No | ||
| kinds | No | ||
| links | Yes | ||
| entity | Yes | ||
| matched | Yes | ||
| citation | Yes | ||
| probable | Yes | ||
| truncated | No | ||
| conventions | No | ||
| group_entities | No |