Skip to main content
GET
/
entities
/
{entityId}
/
shareholders
Get an entity's shareholders
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/shareholders \
  --header 'X-API-Key: <api-key>'
{
  "@context": "<string>",
  "@id": "/entities/91ab5678-1234-5678-9abc-def012345678/shareholders",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/shareholders/91ab5678-1234-5678-9abc-def012345678",
      "@type": "Shareholder",
      "id": "91ab5678-1234-5678-9abc-def012345678",
      "name": "JUAN MANUEL PEREZ GONZALEZ",
      "type": "physical",
      "rfc": "PEIC211118IS0",
      "relations": [
        {
          "@id": "/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890",
          "@type": "ShareholderRelation",
          "id": "82cd9012-3456-7890-abcd-ef1234567890",
          "link": "/entities/91ab5678-1234-5678-9abc-def012345678",
          "shareholder": {},
          "relationType": "shareholders",
          "sources": [
            {
              "@id": "/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources/73de0123-4567-8901-bcde-f23456789012",
              "@type": "ShareholderRelationsSource",
              "id": "73de0123-4567-8901-bcde-f23456789012",
              "relation": {},
              "shareholder": {},
              "sourceName": "manual",
              "sourceId": "64ef1234-5678-9012-cdef-345678901234",
              "shares": 1500.5,
              "createdAt": "2020-01-01T12:15:00.000Z",
              "updatedAt": "2020-01-01T12:15:00.000Z"
            }
          ],
          "shares": 1500.5,
          "totalShares": 10000,
          "ownership": 0.15,
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ],
      "entity": "/entities/91ab5678-1234-5678-9abc-def012345678",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

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

​
id[lt]
string

The collection cursor pointer to the next page

​
id[gt]
string

The collection cursor pointer to the previous page

​
itemsPerPage
integer
default:20

The 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:

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

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

Pagination information

​
hydra:search
object