URL Expired

The URL for this request expired after 30 days.

issuerId
string
required
The identifier of the issuer owning the stakeholders to retrieve.

pageSize
int32
The maximum number of stakeholders to return. The service may return fewer than this value.

If unspecified, at most 25 stakeholders will be returned.

The maximum value is 100; values above 100 will be coerced to 100.

pageToken
string
A page token received as nextPageToken in a previous List Stakeholders response. Provide this to retrieve the subsequent page.

When paginating, all other parameters must be kept consistent with those used in the request where the page token was obtained.

``200 A successful response.

object

The response from the List Stakeholders endpoint.

stakeholders
array of objects
The stakeholders from the specified issuer.

stakeholders
object
A stakeholder is any person or entity who holds an outstanding security.

id
string
length ≤ 50
The identifier of the stakeholder.

issuerId
string
length ≤ 50
An identifier for the issuer related to the stakeholder.

fullName
string
length ≤ 1000
The stakeholder's full legal name.

email
string
length ≤ 1000
The stakeholder's email.

employeeId
string
length ≤ 256
An employee identifier for the stakeholder, if it exists.

relationship
string
enum
The relationship of the stakeholder with the issuer. This will not be set for all stakeholders.

group
string
length ≤ 1000
The group to which the stakeholder belongs. This will not be set for all stakeholders.

entityType
string
enum
length ≤ 1000
The entity type of the stakeholder. This will not be set for all stakeholders.

address
object
The address of the stakeholder. This will not be set for all stakeholders.

address object
nextPageToken
string
Submit the nextPageToken string as pageToken in a subsequent request to retrieve the next page.

If the List Stakeholders response omits nextPageToken, then there are no subsequent pages.

``400 Returned if required fields are omitted or if provided fields fail validation.

``401 Returned if a valid Authorization header has not been included with the request.

``403 Returned when the user does not have permission to access the resource.

``500 Returned if an unexpected internal server error is encountered.

``default An unexpected error response.

Updated about 2 months ago

ShellNodeRubyPHPPython
Bearer
Base URL
https://mock-api.carta.com/v1alpha1/issuers/{issuerId}/stakeholders

xxxxxxxxxx

curl --request GET \
     --url https://mock-api.carta.com/v1alpha1/issuers/issuerId/stakeholders \
     --header 'accept: application/json'

xxxxxxxxxx

{
  "stakeholders": [
    {
      "id": "4902",
      "issuerId": "7",
      "fullName": "Emily Wilson",
      "email": "emily@esharesinc.com",
      "employeeId": "1213511",
      "relationship": "STAKEHOLDER_RELATIONSHIP_EMPLOYEE",
      "group": "Founders",
      "entityType": "INDIVIDUAL",
      "address": {
        "country": "USA"
      }
    }
  ],
  "nextPageToken": "ODMxMw=="
}