Skip to main content
GET
List shareholders

Authorizations

X-API-Key
string
header
required

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

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
type
enum<string>

Filter shareholders by type

Available options:
physical,
legal,
unknown
name
string

Filter shareholders by name (supports partial matching)

rfc
string

Filter shareholders by RFC (supports partial matching)

order[name]
enum<string>

Order by name

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

Shareholders

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

"/shareholders"

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

Pagination information