Skip to main content
GET
List shareholder relations

Authorizations

X-API-Key
string
header
required

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

Path Parameters

shareholderId
string<uuid>
required

The shareholder ID

Query Parameters

id[lt]
string

Collection cursor pointer to the next page

id[gt]
string

Collection cursor pointer to the previous page

itemsPerPage
integer
default:20

Number of items per page

Required range: 1 <= x <= 1000
relationType
enum<string>

Filter relations by type

Available options:
shareholders,
shareholder_of
order[shares]
enum<string>

Order by number of shares

Available options:
asc,
desc
Example:

"asc"

order[ownership]
enum<string>

Order by ownership percentage

Available options:
asc,
desc
Example:

"asc"

order[createdAt]
enum<string>

Order by resource creation date

Available options:
asc,
desc
Example:

"asc"

order[updatedAt]
enum<string>

Order by resource update date

Available options:
asc,
desc
Example:

"asc"

Response

Shareholder Relations

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

"/shareholders/91ab5678-1234-5678-9abc-def012345678/relations"

@type
string
default:hydra:Collection
hydra:member
object[]
hydra:view
object

Pagination information