> ## 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 Employees: Inputs, Cost & CLI Example
> Get the employees of the specified company. 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_employees:{"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.linkedinNumID` | `string` | No | | |
| `payload.linkedinURL` | `string` | No | | LinkedIn URL, accepts company URLs like linkedin.com/company/google or linkedin.com/company/1441 |
| `payload.facebookID` | `string` | No | | |
| `payload.twitterID` | `string` | No | | |
| `payload.crunchbaseID` | `string` | No | | |
| `payload.pitchbookID` | `string` | No | | |
| `payload.producthuntID` | `string` | No | | |
| `payload.dealroomID` | `string` | No | | |
| `payload.goldenID` | `string` | No | | |
| `payload.angellistID` | `string` | No | | |
| `payload.wellfoundID` | `string` | No | | |
| `payload.website` | `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 employees of the specified company.",
"properties": {
"id": {
"type": "string"
},
"linkedinID": {
"type": "string"
},
"linkedinNumID": {
"type": "string"
},
"linkedinURL": {
"type": "string",
"description": "LinkedIn URL, accepts company URLs like linkedin.com/company/google or linkedin.com/company/1441"
},
"facebookID": {
"type": "string"
},
"twitterID": {
"type": "string"
},
"crunchbaseID": {
"type": "string"
},
"pitchbookID": {
"type": "string"
},
"producthuntID": {
"type": "string"
},
"dealroomID": {
"type": "string"
},
"goldenID": {
"type": "string"
},
"angellistID": {
"type": "string"
},
"wellfoundID": {
"type": "string"
},
"website": {
"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": {
"employees": {
"type": "array",
"items": {
"type": "object",
"description": "Work experience object that includes basic person information",
"properties": {
"endDate": {
"type": "string",
"description": "The end date of the work experience, will be null if ongoing.",
"format": "date-time"
},
"startDate": {
"type": "string",
"description": "The start date of the work experience",
"format": "date-time"
},
"linkedinNumID": {
"type": "string",
"description": "The numeric ID of the company on LinkedIn"
},
"linkedinID": {
"type": "string",
"description": "The LinkedIn ID of the company associated with this work experience"
},
"entityType": {
"type": "string",
"enum": [
"person",
"company",
"school",
"organization"
]
},
"positionList": {
"type": "array",
"description": "List of positions held during this work experience",
"items": {
"type": "object",
"description": "This object represents a position held at a given company. It includes the starting and ending date of the position, (ending date is undefined if the position has not yet ended). And it also includes the title of the position.",
"properties": {
"startDate": {
"type": "string",
"description": "The start date of the position"
},
"endDate": {
"type": "string",
"description": "The end date of the position, will be null if ongoing.",
"format": "date-time"
},
"title": {
"type": "string",
"description": "The job title of the position",
"format": "date-time"
},
"location": {
"type": "string",
"description": "The location of the position"
},
"department": {
"type": "string",
"description": "The department of the position"
},
"seniorityScore": {
"type": "integer",
"description": "The seniority score of the position (1-7)"
},
"description": {
"type": "string",
"description": "Description of position as provided by the person"
}
},
"additionalProperties": false
}
},
"personID": {
"type": "string",
"description": "The ID of the person who had this work experience"
},
"companyID": {
"type": "string",
"description": "The ID of the company where the person worked"
},
"companyName": {
"type": "string",
"description": "The name of the company where the person worked"
},
"person": {
"type": "object",
"description": "A Person Object, with only the most essentail information to identify the person",
"properties": {
"id": {
"type": "string",
"description": "The Aviato ID of the person"
},
"fullName": {
"type": "string",
"description": "The full name of the person"
},
"firstName": {
"type": "string",
"description": "The first name of the person"
},
"lastName": {
"type": "string",
"description": "The last name of the person"
},
"entityType": {
"type": "string",
"enum": [
"person",
"company",
"school",
"organization"
]
},
"location": {
"type": "string",
"description": "The location of the person."
},
"URLs": {
"type": "object",
"description": "This object represents different urls that can be associated with any type of entity. (Does not include http prefix)",
"properties": {
"golden": {
"type": "string"
},
"contact": {
"type": "string"
},
"twitter": {
"type": "string"
},
"website": {
"type": "string"
},
"facebook": {
"type": "string"
},
"github": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"pitchbook": {
"type": "string"
},
"angelList": {
"type": "string"
},
"signalNFX": {
"type": "string"
},
"crunchbase": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"id",
"fullName",
"firstName",
"lastName"
],
"additionalProperties": false
}
},
"required": [
"positionList",
"personID",
"person"
],
"additionalProperties": false
}
},
"pages": {
"type": "integer"
},
"totalResults": {
"type": "integer"
}
},
"required": [
"employees",
"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_employees --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: `0.07` per pricing unit.
* Billing mode: `post_deduct`.