Org settings, dashboards & reporting

Get Employee Dashboard

Totals the caller's non-SCP grants split fiat/token: granted, vested, unlocked, settled, pending settlement value.

GEThttps://api.toku.com/tga/get-employee-dashboard

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/tga/get-employee-dashboard' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "grants": [
    {
      "grantID": "string",
      "roleInOrgID": "string",
      "grantConfigurationID": "string",
      "isVestingEnabled": true,
      "isExerciseEnabled": true,
      "grantName": "string",
      "grantDescription": "string",
      "grantDate": "string",
      "grantStatus": "PENDING",
      "grantAmount": "string",
      "grantAmountInFiat": "string",
      "grantAssetType": "TOKEN",
      "isCashCompensation": true,
      "isLockup": true,
      "legacyMigratedAt": "string",
      "legacyModelID": 0,
      "taxCurrencyCode": "TRY",
      "grantAdminCurrencyCode": "TRY",
      "vestingStartDate": "string",
      "offPlatformDate": "string",
      "vestingFrequencyType": "MONTHLY",
      "vestingPeriods": "string",
      "vestingCliffPeriods": 0,
      "vestingCliffPercentage": "string",
      "scheduleStringOverride": "string",
      "pricePerUnit": "string",
      "pricePerUnitCurrencyCode": "string",
      "priceTotal": "string",
      "tokenName": "string",
      "tokenTypeID": "string",
      "stablecoinSplitPercentage": "string",
      "strikePrice": "string",
      "strikePriceCurrencyCode": "string",
      "strikeCostTotal": "string",
      "anchorageSettlementWalletID": "string",
      "section83BElectionEligible": true,
      "isTaxable": true,
      "terminationDate": "string",
      "futureTerminationDate": "string",
      "awardDate": "string",
      "strikeDate": "string",
      "optionExpiresAt": "string",
      "optionExpiryNotifiedAt": "string",
      "allocationType": "string",
      "averageBasis": "string",
      "currency": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string",
      "grantTemplateID": "string",
      "cliffOverrideString": "string",
      "isSCPGrant": true,
      "isAutoVestingEnabled": true,
      "vestings": [
        {
          "vestingID": "string",
          "roleInOrgID": "string",
          "grantID": "string",
          "vestingDate": "string",
          "vestedUnits": "string",
          "accruedUnits": "string",
          "sequence": 0,
          "status": "PENDING",
          "settlementID": "string",
          "taxReferenceID": "string",
          "legacyMigratedAt": "string",
          "legacyModelID": 0,
          "performanceFactor": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "deletedAt": "string",
          "tokenName": "string",
          "payrollID": "string",
          "taxEngineProcessingState": "NO_TAX_ENGINE_USED",
          "taxEnginePayrollID": "string",
          "taxEngineClaimID": "string",
          "fiatFmv": "string",
          "isOffPlatform": true,
          "payrollReportingGroupID": "string",
          "settlementRecord": {
            "settlementID": "string",
            "roleInOrgID": "string",
            "settledUnits": "string",
            "settledDate": "string",
            "settlementMethod": "TOKEN",
            "createdAt": "string",
            "updatedAt": "string",
            "documentID": "string",
            "legacyMigratedAt": "string",
            "legacyModelID": 0,
            "tokenName": "string",
            "withheldUnits": "string",
            "fmv": "string",
            "recordedVia": "string",
            "revision": 0,
            "supersededDocumentIDs": [
              "string"
            ],
            "cashUnits": "string"
          }
        }
      ],
      "lockups": [
        {
          "legacyMigratedAt": "string",
          "legacyModelID": 0,
          "lockupID": "string",
          "roleInOrgID": "string",
          "grantID": "string",
          "unlockDate": "string",
          "unlockUnits": "string",
          "sequence": 0,
          "settledUnits": "string",
          "cumulativeUnlockAmount": "string",
          "cumulativeTokensUnlocked": "string",
          "settlementID": "string",
          "taxReferenceID": "string",
          "status": "PENDING",
          "taxVestingStatus": "PENDING",
          "createdAt": "string",
          "updatedAt": "string",
          "deletedAt": "string",
          "fiatFmv": "string",
          "taxEngineProcessingState": "NO_TAX_ENGINE_USED",
          "taxEnginePayrollID": "string",
          "taxEngineClaimID": "string",
          "payrollReportingGroupID": "string",
          "settlementRecord": {
            "settlementID": "string",
            "roleInOrgID": "string",
            "settledUnits": "string",
            "settledDate": "string",
            "settlementMethod": "TOKEN",
            "createdAt": "string",
            "updatedAt": "string",
            "documentID": "string",
            "legacyMigratedAt": "string",
            "legacyModelID": 0,
            "tokenName": "string",
            "withheldUnits": "string",
            "fmv": "string",
            "recordedVia": "string",
            "revision": 0,
            "supersededDocumentIDs": [
              "string"
            ],
            "cashUnits": "string"
          }
        }
      ],
      "exerciseRequests": [
        {
          "exerciseRequestID": "string",
          "roleInOrgID": "string",
          "grantID": "string",
          "status": "PENDING_AGREEMENT",
          "units": "string",
          "settlementMethod": "TOKEN",
          "documentID": "string",
          "addedByRoleInOrgID": "string",
          "rejectedAt": "string",
          "rejectedReason": "string",
          "rejectedByRoleInOrgID": "string",
          "approvedByRoleInOrgID": "string",
          "approvedAt": "string",
          "taxReferenceID": "string",
          "settlementID": "string",
          "lockedUntil": "string",
          "lockupEndNotifiedAt": "string",
          "paymentReceivedAt": "string",
          "paymentAmount": "string",
          "paymentCurrencyCode": "string",
          "paymentReference": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "deletedAt": "string",
          "settlementRecord": {
            "settlementID": "string",
            "roleInOrgID": "string",
            "settledUnits": "string",
            "settledDate": "string",
            "settlementMethod": "TOKEN",
            "createdAt": "string",
            "updatedAt": "string",
            "documentID": "string",
            "legacyMigratedAt": "string",
            "legacyModelID": 0,
            "tokenName": "string",
            "withheldUnits": "string",
            "fmv": "string",
            "recordedVia": "string",
            "revision": 0,
            "supersededDocumentIDs": [
              "string"
            ],
            "cashUnits": "string"
          }
        }
      ],
      "tokenType": {
        "currencyCode": "string"
      },
      "roleInOrg": {
        "org": {
          "tokenName": "string"
        }
      },
      "tokenSymbol": "string"
    }
  ],
  "tokenSummaries": [
    {
      "symbol": "string",
      "granted": "string",
      "vested": "string",
      "settled": "string"
    }
  ],
  "grantsCount": 0,
  "fiatGrantsTotal": "string",
  "tokenGrantsTotal": "string",
  "vestedUnitsTotalToken": "string",
  "vestedUnitsTotalFiat": "string",
  "settledUnitsTotal": "string",
  "settledUnitsTotalFiat": "string",
  "settledUnitsTotalToken": "string",
  "unlockedUnitsTotalToken": "string",
  "unlockedUnitsTotalFiat": "string",
  "upcomingVestings": [
    {
      "vestingID": "string",
      "roleInOrgID": "string",
      "grantID": "string",
      "vestingDate": "string",
      "vestedUnits": "string",
      "accruedUnits": "string",
      "sequence": 0,
      "status": "PENDING",
      "settlementID": "string",
      "taxReferenceID": "string",
      "legacyMigratedAt": "string",
      "legacyModelID": 0,
      "performanceFactor": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string",
      "tokenName": "string",
      "payrollID": "string",
      "taxEngineProcessingState": "NO_TAX_ENGINE_USED",
      "taxEnginePayrollID": "string",
      "taxEngineClaimID": "string",
      "fiatFmv": "string",
      "isOffPlatform": true,
      "payrollReportingGroupID": "string",
      "settlementRecord": {
        "settlementID": "string",
        "roleInOrgID": "string",
        "settledUnits": "string",
        "settledDate": "string",
        "settlementMethod": "TOKEN",
        "createdAt": "string",
        "updatedAt": "string",
        "documentID": "string",
        "legacyMigratedAt": "string",
        "legacyModelID": 0,
        "tokenName": "string",
        "withheldUnits": "string",
        "fmv": "string",
        "recordedVia": "string",
        "revision": 0,
        "supersededDocumentIDs": [
          "string"
        ],
        "cashUnits": "string"
      },
      "tokenSymbol": "string"
    }
  ],
  "tokensValueToBeSettledFiat": "string",
  "tokensValueToBeSettledToken": "string"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Response

200Successful response
grantsobject[]required
Show child attributes
grantIDstringrequired
roleInOrgIDstringrequired
grantConfigurationIDstringrequired
isVestingEnabledbooleanrequired
isExerciseEnabledbooleanrequired
grantNamestringrequired
grantDescriptionstringrequired
grantDatestringrequired
grantStatusstringrequired

Available options: PENDING, REJECTED, ACCEPTED, COMPLETED, TERMINATED, PAUSED, MARKED_FOR_FUTURE_TERMINATION

grantAmountstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

grantAmountInFiatstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

grantAssetTypestring | nullrequired

Available options: TOKEN, FIAT, null

isCashCompensationboolean | nullrequired
isLockupboolean | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
taxCurrencyCodestring | nullrequired

Available options: TRY, ILS, CRC, TTD, SGD, JPY, AUD, NOK, INR, GBP, CHF, RUB, CAD, BRL, NGN, KRW, AED, LBP, EUR, NZD, ZAR, USD, USDC, USDT, USDP, PHP, PLN, RSD, HKD, TWD, AFN, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BSD, BTN, BWP, BYN, BZD, CDF, CLF, CLP, CNY, COP, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HNL, HRK, HTG, HUF, IDR, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NPR, NIO, OMR, PAB, PEN, PGK, PKR, PYG, QAR, RON, RWF, SAR, SBD, SCR, SDG, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, TJS, TMT, TND, TOP, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZMW, SEK, THB, null

grantAdminCurrencyCodestring | nullrequired

Available options: TRY, ILS, CRC, TTD, SGD, JPY, AUD, NOK, INR, GBP, CHF, RUB, CAD, BRL, NGN, KRW, AED, LBP, EUR, NZD, ZAR, USD, USDC, USDT, USDP, PHP, PLN, RSD, HKD, TWD, AFN, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BSD, BTN, BWP, BYN, BZD, CDF, CLF, CLP, CNY, COP, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HNL, HRK, HTG, HUF, IDR, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NPR, NIO, OMR, PAB, PEN, PGK, PKR, PYG, QAR, RON, RWF, SAR, SBD, SCR, SDG, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, TJS, TMT, TND, TOP, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZMW, SEK, THB, null

vestingStartDatestringrequired
offPlatformDatestring | nullrequired
vestingFrequencyTypestring | nullrequired

Available options: MONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY, CUSTOM, DAILY, WEEKLY, null

vestingPeriodsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

vestingCliffPeriodsinteger | nullrequired
vestingCliffPercentagestring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

scheduleStringOverridestring | nullrequired
pricePerUnitstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

pricePerUnitCurrencyCodestring | nullrequired
priceTotalstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

tokenNamestring | nullrequired
tokenTypeIDstring | nullrequired
stablecoinSplitPercentagestring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

strikePricestring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

strikePriceCurrencyCodestring | nullrequired
strikeCostTotalstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

anchorageSettlementWalletIDstring | nullrequired
section83BElectionEligiblebooleanrequired
isTaxablebooleanrequired
terminationDatestring | nullrequired
futureTerminationDatestring | nullrequired
grantTerminationsanyrequired
awardDatestring | nullrequired
strikeDatestring | nullrequired
optionExpiresAtstring | nullrequired
optionExpiryNotifiedAtstring | nullrequired
allocationTypestring | nullrequired
averageBasisstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

currencystring | nullrequired
createdAtstringrequired
updatedAtstringrequired
deletedAtstring | nullrequired
grantTemplateIDstring | nullrequired
cliffOverrideStringstring | nullrequired
isSCPGrantboolean | nullrequired
isAutoVestingEnabledboolean | nullrequired
vestingsobject[]required
Show child attributes
vestingIDstringrequired
roleInOrgIDstringrequired
grantIDstringrequired
vestingDatestringrequired
vestedUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

accruedUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

sequenceintegerrequired
statusstringrequired

Available options: PENDING, VESTED, FORFEITED, EXPIRED, CANCELLED, OFF_PLATFORM, UNLOCKED, SETTLED

settlementIDstring | nullrequired
taxReferenceIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
performanceFactorstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

createdAtstringrequired
updatedAtstringrequired
deletedAtstring | nullrequired
tokenNamestring | nullrequired
payrollIDstring | nullrequired
taxEngineProcessingStatestring | nullrequired

Available options: NO_TAX_ENGINE_USED, PROCESSING, COMPLETED, null

taxEnginePayrollIDstring | nullrequired
taxEngineClaimIDstring | nullrequired
fiatFmvstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

isOffPlatformboolean | nullrequired
payrollReportingGroupIDstring | nullrequired
settlementRecordobject | nullrequired
Show child attributes
settlementIDstringrequired
roleInOrgIDstringrequired
settledUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledDatestringrequired
settlementMethodstringrequired

Available options: TOKEN, CASH

createdAtstringrequired
updatedAtstringrequired
documentIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
tokenNamestring | nullrequired
withheldUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

fmvstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

scheduleAmountsanyrequired
recordedViastring | nullrequired
revisionintegerrequired
supersededDocumentIDsstring[]required
cashUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

lockupsobject[]required
Show child attributes
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
lockupIDstringrequired
roleInOrgIDstringrequired
grantIDstringrequired
unlockDatestringrequired
unlockUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

sequenceintegerrequired
settledUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

cumulativeUnlockAmountstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

cumulativeTokensUnlockedstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settlementIDstring | nullrequired
taxReferenceIDstring | nullrequired
statusstring | nullrequired

Available options: PENDING, VESTED, FORFEITED, EXPIRED, CANCELLED, OFF_PLATFORM, UNLOCKED, SETTLED, null

taxVestingStatusstring | nullrequired

Available options: PENDING, APPROVED, null

createdAtstringrequired
updatedAtstringrequired
deletedAtstring | nullrequired
fiatFmvstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

taxEngineProcessingStatestring | nullrequired

Available options: NO_TAX_ENGINE_USED, PROCESSING, COMPLETED, null

taxEnginePayrollIDstring | nullrequired
taxEngineClaimIDstring | nullrequired
payrollReportingGroupIDstring | nullrequired
settlementRecordobject | nullrequired
Show child attributes
settlementIDstringrequired
roleInOrgIDstringrequired
settledUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledDatestringrequired
settlementMethodstringrequired

Available options: TOKEN, CASH

createdAtstringrequired
updatedAtstringrequired
documentIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
tokenNamestring | nullrequired
withheldUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

fmvstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

scheduleAmountsanyrequired
recordedViastring | nullrequired
revisionintegerrequired
supersededDocumentIDsstring[]required
cashUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

exerciseRequestsobject[]required
Show child attributes
exerciseRequestIDstringrequired
roleInOrgIDstringrequired
grantIDstringrequired
statusstringrequired

Available options: PENDING_AGREEMENT, PENDING_TOKU_ACCEPTANCE, PENDING_TAX_APPROVAL, PENDING_SETTLEMENT, SETTLED, EXERCISE_REQUEST_IMPORTED_FROM_OFF_PLATFORM, REJECTED

unitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settlementMethodstringrequired

Available options: TOKEN, CASH

documentIDstring | nullrequired
addedByRoleInOrgIDstring | nullrequired
rejectedAtstring | nullrequired
rejectedReasonstring | nullrequired
rejectedByRoleInOrgIDstring | nullrequired
approvedByRoleInOrgIDstring | nullrequired
approvedAtstring | nullrequired
taxReferenceIDstring | nullrequired
settlementIDstring | nullrequired
lockedUntilstring | nullrequired
lockupEndNotifiedAtstring | nullrequired
paymentReceivedAtstring | nullrequired
paymentAmountstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

paymentCurrencyCodestring | nullrequired
paymentReferencestring | nullrequired
createdAtstringrequired
updatedAtstringrequired
deletedAtstring | nullrequired
settlementRecordobject | nullrequired
Show child attributes
settlementIDstringrequired
roleInOrgIDstringrequired
settledUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledDatestringrequired
settlementMethodstringrequired

Available options: TOKEN, CASH

createdAtstringrequired
updatedAtstringrequired
documentIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
tokenNamestring | nullrequired
withheldUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

fmvstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

scheduleAmountsanyrequired
recordedViastring | nullrequired
revisionintegerrequired
supersededDocumentIDsstring[]required
cashUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

tokenTypeobject | nullrequired
Show child attributes
currencyCodestringrequired
roleInOrgobjectrequired
Show child attributes
orgobjectrequired
Show child attributes
tokenNamestring | nullrequired
tokenSymbolstring
tokenSummariesobject[]required
Show child attributes
symbolstringrequired
grantedstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

vestedstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

grantsCountintegerrequired
fiatGrantsTotalstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

tokenGrantsTotalstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

vestedUnitsTotalTokenstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

vestedUnitsTotalFiatstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledUnitsTotalstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledUnitsTotalFiatstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledUnitsTotalTokenstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

unlockedUnitsTotalTokenstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

unlockedUnitsTotalFiatstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

upcomingVestingsobject[]required
Show child attributes
vestingIDstringrequired
roleInOrgIDstringrequired
grantIDstringrequired
vestingDatestringrequired
vestedUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

accruedUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

sequenceintegerrequired
statusstringrequired

Available options: PENDING, VESTED, FORFEITED, EXPIRED, CANCELLED, OFF_PLATFORM, UNLOCKED, SETTLED

settlementIDstring | nullrequired
taxReferenceIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
performanceFactorstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

createdAtstringrequired
updatedAtstringrequired
deletedAtstring | nullrequired
tokenNamestring | nullrequired
payrollIDstring | nullrequired
taxEngineProcessingStatestring | nullrequired

Available options: NO_TAX_ENGINE_USED, PROCESSING, COMPLETED, null

taxEnginePayrollIDstring | nullrequired
taxEngineClaimIDstring | nullrequired
fiatFmvstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

isOffPlatformboolean | nullrequired
payrollReportingGroupIDstring | nullrequired
settlementRecordobject | nullrequired
Show child attributes
settlementIDstringrequired
roleInOrgIDstringrequired
settledUnitsstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

settledDatestringrequired
settlementMethodstringrequired

Available options: TOKEN, CASH

createdAtstringrequired
updatedAtstringrequired
documentIDstring | nullrequired
legacyMigratedAtstring | nullrequired
legacyModelIDinteger | nullrequired
tokenNamestring | nullrequired
withheldUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

fmvstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

scheduleAmountsanyrequired
recordedViastring | nullrequired
revisionintegerrequired
supersededDocumentIDsstring[]required
cashUnitsstring | nullrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

tokenSymbolstring
tokensValueToBeSettledFiatstring

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

tokensValueToBeSettledTokenstring

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits