Aviato: Get Employees

Get the employees of the specified company.

Tool ID: aviato_get_employees

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

console.log(result.toolResponse.raw);

CLI

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

Example response

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

{
  "data": {
    "employees": [
      {
        "positionList": [
          {}
        ],
        "personID": "person_123",
        "person": {
          "id": "id_123",
          "fullName": "Example",
          "firstName": "Jane",
          "lastName": "Doe"
        }
      }
    ],
    "pages": 123,
    "totalResults": 123
  }
}

Use deepline tools get 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.

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

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Aviato: Get Employees

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