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

> Get the employees of the specified company. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get the employees of the specified company.

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

## 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_employees',
  {
    "perPage": 123,
    "page": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute aviato_get_employees --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": {
    "employees": [
      {
        "positionList": [
          {}
        ],
        "personID": "person_123",
        "person": {
          "id": "id_123",
          "fullName": "Example",
          "firstName": "Jane",
          "lastName": "Doe"
        }
      }
    ],
    "pages": 123,
    "totalResults": 123
  }
}
```

Use `deepline describe aviato_get_employees --json` for the latest machine-readable contract.

## Input reference

Get the employees of the specified company.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `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. |

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

  ### Input JSON Schema

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

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.employees` | `array` | Yes | — | — |
| `result.data.employees[].endDate` | `string` | No | — | The end date of the work experience, will be null if ongoing. Format: `date-time`. |
| `result.data.employees[].startDate` | `string` | No | — | The start date of the work experience Format: `date-time`. |
| `result.data.employees[].linkedinNumID` | `string` | No | — | The numeric ID of the company on LinkedIn |
| `result.data.employees[].linkedinID` | `string` | No | — | The LinkedIn ID of the company associated with this work experience |
| `result.data.employees[].entityType` | `"person" \| "company" \| "school" \| "organization"` | No | — | Allowed: `person`, `company`, `school`, `organization`. |
| `result.data.employees[].positionList` | `array` | Yes | — | List of positions held during this work experience |
| `result.data.employees[].positionList[].startDate` | `string` | No | — | The start date of the position |
| `result.data.employees[].positionList[].endDate` | `string` | No | — | The end date of the position, will be null if ongoing. Format: `date-time`. |
| `result.data.employees[].positionList[].title` | `string` | No | — | The job title of the position Format: `date-time`. |
| `result.data.employees[].positionList[].location` | `string` | No | — | The location of the position |
| `result.data.employees[].positionList[].department` | `string` | No | — | The department of the position |
| `result.data.employees[].positionList[].seniorityScore` | `integer` | No | — | The seniority score of the position (1-7) |
| `result.data.employees[].positionList[].description` | `string` | No | — | Description of position as provided by the person |
| `result.data.employees[].personID` | `string` | Yes | — | The ID of the person who had this work experience |
| `result.data.employees[].companyID` | `string` | No | — | The ID of the company where the person worked |
| `result.data.employees[].companyName` | `string` | No | — | The name of the company where the person worked |
| `result.data.employees[].person` | `object` | Yes | — | A Person Object, with only the most essentail information to identify the person |
| `result.data.employees[].person.id` | `string` | Yes | — | The Aviato ID of the person |
| `result.data.employees[].person.fullName` | `string` | Yes | — | The full name of the person |
| `result.data.employees[].person.firstName` | `string` | Yes | — | The first name of the person |
| `result.data.employees[].person.lastName` | `string` | Yes | — | The last name of the person |
| `result.data.employees[].person.entityType` | `"person" \| "company" \| "school" \| "organization"` | No | — | Allowed: `person`, `company`, `school`, `organization`. |
| `result.data.employees[].person.location` | `string` | No | — | The location of the person. |
| `result.data.employees[].person.URLs` | `object` | No | — | This object represents different urls that can be associated with any type of entity. (Does not include http prefix) |
| `result.data.employees[].person.URLs.golden` | `string` | No | — | — |
| `result.data.employees[].person.URLs.contact` | `string` | No | — | — |
| `result.data.employees[].person.URLs.twitter` | `string` | No | — | — |
| `result.data.employees[].person.URLs.website` | `string` | No | — | — |
| `result.data.employees[].person.URLs.facebook` | `string` | No | — | — |
| `result.data.employees[].person.URLs.github` | `string` | No | — | — |
| `result.data.employees[].person.URLs.linkedin` | `string` | No | — | — |
| `result.data.employees[].person.URLs.pitchbook` | `string` | No | — | — |
| `result.data.employees[].person.URLs.angelList` | `string` | No | — | — |
| `result.data.employees[].person.URLs.signalNFX` | `string` | No | — | — |
| `result.data.employees[].person.URLs.crunchbase` | `string` | No | — | — |
| `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": {
          "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
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0.07` 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.