Skip to main content
GET
Get shareholders
To export this insight, use Insight Export with shareholders as the insight name and pass the relation type as options[relations.relationType].

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId
string<uuid>
required

Query Parameters

relations.relationType
enum<string>
required

Shareholder relation direction to return

Available options:
shareholders,
shareholder_of
page
integer
default:1

Page number for pagination

Required range: x >= 1
itemsPerPage
integer
default:1000

Number of items per page

Required range: 1 <= x <= 1000

Response

Shareholders insight

@context
string
default:/contexts/GetShareholdersInsight
@id
string
Example:

"/entities/91ab5678-1234-5678-9abc-def012345678/insights/shareholders?relations.relationType=shareholders"

@type
string
default:hydra:Collection
hydra:member
object[]
hydra:totalItems
integer

Total number of items found

Required range: x >= 0
Example:

1

hydra:view
object

Pagination information