Skip to main content
GET
List shareholder relation sources

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

relationId
string<uuid>
required

The relation 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
sourceName
enum<string>

Filter sources by name

Available options:
manual,
rpc_socio,
company_verification
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 Relation Sources

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

"/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources"

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

Pagination information