Aviato: Get Vestings

Get the vestings of a person.

Tool ID: aviato_get_vestings

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'aviato_get_vestings',
  {
    "perPage": 123,
    "page": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute aviato_get_vestings --input '{
  "perPage": 123,
  "page": 123
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "vestings": [
      {
        "id": "id_123"
      }
    ],
    "pages": 123,
    "totalResults": 123
  }
}

Use deepline tools get aviato_get_vestings --json for the latest machine-readable contract.

Input reference

Get the vestings of a person.

Name	Type	Required	Default	Details
`payload.id`	`string`	No	—	—
`payload.linkedinID`	`string`	No	—	—
`payload.linkedinEntityId`	`string`	No	—	LinkedIn entity ID
`payload.linkedinURL`	`string`	No	—	LinkedIn URL, accepts public profile (linkedin.com/in/), Sales Navigator, and Recruiter URLs
`payload.twitterID`	`string`	No	—	—
`payload.crunchbaseID`	`string`	No	—	—
`payload.angelListID`	`string`	No	—	—
`payload.signalNfxID`	`string`	No	—	—
`payload.polyworkID`	`string`	No	—	—
`payload.email`	`string`	No	—	—
`payload.perPage`	`integer`	Yes	—	Number of items per page.
`payload.page`	`integer`	Yes	—	Page number, starts from 0.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.vestings`	`array`	Yes	—	—
`result.data.vestings[].id`	`string`	Yes	—	The unique identifier of the vesting record
`result.data.vestings[].grantDate`	`string`	No	—	The date when the equity grant was made Format: `date-time`.
`result.data.vestings[].initialShares`	`integer`	No	—	The initial number of shares granted
`result.data.vestings[].initialSharesValue`	`number`	No	—	The initial value (USD) of the shares granted Format: `double`.
`result.data.vestings[].sharePriceAtGrantDate`	`number`	No	—	The share price (USD) at the time of grant Format: `double`.
`result.data.vestings[].currentSharePrice`	`number`	No	—	The current share price (USD) Format: `double`.
`result.data.vestings[].cliffPeriod`	`integer`	No	—	The cliff period in days before vesting begins
`result.data.vestings[].daysPastCliff`	`integer`	No	—	Number of days past the cliff period
`result.data.vestings[].selectedJobFamily`	`string`	No	—	The job family selected for this vesting schedule
`result.data.vestings[].selectedLevel`	`string`	No	—	The level selected for this vesting schedule
`result.data.vestings[].experienceID`	`string`	No	—	ID of the work experience associated with this vesting
`result.data.vestings[].companyID`	`string`	No	—	ID of the company where this vesting applies
`result.data.vestings[].percentVested`	`number`	No	—	The percentage of shares that have vested as of now Format: `double`.
`result.data.vestings[].minVestedShares`	`integer`	No	—	The minimum number of shares vested
`result.data.vestings[].maxVestedShares`	`integer`	No	—	The maximum number of shares vested
`result.data.vestings[].nextBatchDate`	`string`	No	—	The date of the next vesting batch Format: `date-time`.
`result.data.vestings[].nextBatchMinShares`	`integer`	No	—	The minimum shares in the next vesting batch
`result.data.vestings[].nextBatchMaxShares`	`integer`	No	—	The maximum shares in the next vesting batch
`result.data.vestings[].nextBatchMinValueOfficial`	`number`	No	—	The minimum official value (USD) of the next vesting batch Format: `double`.
`result.data.vestings[].nextBatchMaxValueOfficial`	`number`	No	—	The maximum official value (USD) of the next vesting batch Format: `double`.
`result.data.vestings[].nextBatchMinValueSecondary`	`number`	No	—	The minimum secondary market value (USD) of the next vesting batch Format: `double`.
`result.data.vestings[].nextBatchMaxValueSecondary`	`number`	No	—	The maximum secondary market value (USD) of the next vesting batch Format: `double`.
`result.data.vestings[].vestingStatus`	`"ACTIVE" \| "COMPLETED" \| "CANCELLED" \| "INVALID"`	No	—	The status of a vesting schedule Allowed: `ACTIVE`, `COMPLETED`, `CANCELLED`, `INVALID`.
`result.data.vestings[].minVestedSharesValueOfficial`	`number`	No	—	The minimum official value (USD) of vested shares Format: `double`.
`result.data.vestings[].minVestedSharesValueSecondary`	`number`	No	—	The minimum secondary market value (USD) of vested shares Format: `double`.
`result.data.vestings[].maxVestedSharesValueOfficial`	`number`	No	—	The maximum official value (USD) of vested shares Format: `double`.
`result.data.vestings[].maxVestedSharesValueSecondary`	`number`	No	—	The maximum secondary market value (USD) of vested shares Format: `double`.
`result.data.vestings[].vestingPeriods`	`integer`	No	—	The number of vesting periods in the schedule
`result.data.vestings[].avgTotalCompensationPerYear`	`number`	No	—	The average total compensation (USD) per year Format: `double`.
`result.data.vestings[].avgBaseSalaryPerYear`	`number`	No	—	The average base salary (USD) per year Format: `double`.
`result.data.vestings[].avgStockGrantPerYear`	`number`	No	—	The average stock grant value (USD) per year Format: `double`.
`result.data.vestings[].personLatestJobFamily`	`string`	No	—	The person’s latest job family
`result.data.vestings[].personLatestLevel`	`string`	No	—	The person’s latest level
`result.data.pages`	`integer`	Yes	—	—
`result.data.totalResults`	`integer`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 1.4 per pricing unit.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Aviato: Get Vestings

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation