> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Aviato Get Vestings: Inputs, Cost & CLI Example
> Get the vestings of a person. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=aviato_get_vestings:{"perPage":"{{perPage}}","page":"{{page}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `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. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get the vestings of a person.",
"properties": {
"id": {
"type": "string"
},
"linkedinID": {
"type": "string"
},
"linkedinEntityId": {
"type": "string",
"description": "LinkedIn entity ID"
},
"linkedinURL": {
"type": "string",
"description": "LinkedIn URL, accepts public profile (linkedin.com/in/), Sales Navigator, and Recruiter URLs"
},
"twitterID": {
"type": "string"
},
"crunchbaseID": {
"type": "string"
},
"angelListID": {
"type": "string"
},
"signalNfxID": {
"type": "string"
},
"polyworkID": {
"type": "string"
},
"email": {
"type": "string"
},
"perPage": {
"type": "integer",
"description": "Number of items per page."
},
"page": {
"type": "integer",
"description": "Page number, starts from 0."
}
},
"required": [
"perPage",
"page"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"vestings": {
"type": "array",
"items": {
"type": "object",
"description": "Vesting object represents vesting information of a person. It includes the vesting schedule, shares vested, cliffs, etc.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the vesting record"
},
"grantDate": {
"type": "string",
"description": "The date when the equity grant was made",
"format": "date-time"
},
"initialShares": {
"type": "integer",
"description": "The initial number of shares granted"
},
"initialSharesValue": {
"type": "number",
"description": "The initial value (USD) of the shares granted",
"format": "double"
},
"sharePriceAtGrantDate": {
"type": "number",
"description": "The share price (USD) at the time of grant",
"format": "double"
},
"currentSharePrice": {
"type": "number",
"description": "The current share price (USD)",
"format": "double"
},
"cliffPeriod": {
"type": "integer",
"description": "The cliff period in days before vesting begins"
},
"daysPastCliff": {
"type": "integer",
"description": "Number of days past the cliff period"
},
"selectedJobFamily": {
"type": "string",
"description": "The job family selected for this vesting schedule"
},
"selectedLevel": {
"type": "string",
"description": "The level selected for this vesting schedule"
},
"experienceID": {
"type": "string",
"description": "ID of the work experience associated with this vesting"
},
"companyID": {
"type": "string",
"description": "ID of the company where this vesting applies"
},
"percentVested": {
"type": "number",
"description": "The percentage of shares that have vested as of now",
"format": "double"
},
"minVestedShares": {
"type": "integer",
"description": "The minimum number of shares vested"
},
"maxVestedShares": {
"type": "integer",
"description": "The maximum number of shares vested"
},
"nextBatchDate": {
"type": "string",
"description": "The date of the next vesting batch",
"format": "date-time"
},
"nextBatchMinShares": {
"type": "integer",
"description": "The minimum shares in the next vesting batch"
},
"nextBatchMaxShares": {
"type": "integer",
"description": "The maximum shares in the next vesting batch"
},
"nextBatchMinValueOfficial": {
"type": "number",
"description": "The minimum official value (USD) of the next vesting batch",
"format": "double"
},
"nextBatchMaxValueOfficial": {
"type": "number",
"description": "The maximum official value (USD) of the next vesting batch",
"format": "double"
},
"nextBatchMinValueSecondary": {
"type": "number",
"description": "The minimum secondary market value (USD) of the next vesting batch",
"format": "double"
},
"nextBatchMaxValueSecondary": {
"type": "number",
"description": "The maximum secondary market value (USD) of the next vesting batch",
"format": "double"
},
"vestingStatus": {
"type": "string",
"description": "The status of a vesting schedule",
"enum": [
"ACTIVE",
"COMPLETED",
"CANCELLED",
"INVALID"
]
},
"minVestedSharesValueOfficial": {
"type": "number",
"description": "The minimum official value (USD) of vested shares",
"format": "double"
},
"minVestedSharesValueSecondary": {
"type": "number",
"description": "The minimum secondary market value (USD) of vested shares",
"format": "double"
},
"maxVestedSharesValueOfficial": {
"type": "number",
"description": "The maximum official value (USD) of vested shares",
"format": "double"
},
"maxVestedSharesValueSecondary": {
"type": "number",
"description": "The maximum secondary market value (USD) of vested shares",
"format": "double"
},
"vestingPeriods": {
"type": "integer",
"description": "The number of vesting periods in the schedule"
},
"avgTotalCompensationPerYear": {
"type": "number",
"description": "The average total compensation (USD) per year",
"format": "double"
},
"avgBaseSalaryPerYear": {
"type": "number",
"description": "The average base salary (USD) per year",
"format": "double"
},
"avgStockGrantPerYear": {
"type": "number",
"description": "The average stock grant value (USD) per year",
"format": "double"
},
"personLatestJobFamily": {
"type": "string",
"description": "The person's latest job family"
},
"personLatestLevel": {
"type": "string",
"description": "The person's latest level"
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"pages": {
"type": "integer"
},
"totalResults": {
"type": "integer"
}
},
"required": [
"vestings",
"pages",
"totalResults"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute aviato_get_vestings --payload '{
"perPage": "integer",
"page": "integer"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `1.4` per pricing unit.
* Billing mode: `post_deduct`.