> ## 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

> List a person's equity vesting records, from their LinkedIn URL, email or another profile ID. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List a person's equity vesting records, from their LinkedIn URL, email or another profile ID.

> [!NOTE]
>
> Tool ID: `aviato_get_vestings`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute aviato_get_vestings --input '{
  "perPage": 123,
  "page": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "vestings": [
      {
        "id": "id_123"
      }
    ],
    "pages": 123,
    "totalResults": 123
  }
}
```

Use `deepline describe 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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Aviato provider guide](https://deepline.com/docs/providers/aviato/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.