GET
/
employer
/
directory
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

// Automatically fetches more pages as needed.
for await (const individualInDirectory of client.hris.directory.list()) {
  console.log(individualInDirectory.id);
}
{
  "paging": {
    "count": 25,
    "offset": 10
  },
  "individuals": [
    {
      "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
      "first_name": "Jane",
      "middle_name": null,
      "last_name": "Doe",
      "manager": {
        "id": "c205b3fa-b626-4346-bf0f-ca065ab88d31"
      },
      "department": {
        "name": "Product"
      },
      "is_active": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string<date>
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Query Parameters

​
limit
integer

Number of employees to return (defaults to all)

​
offset
integer

Index to start from (defaults to 0)

Response

Company directory and organization structure

​
paging
object
required
​
individuals
object[]
required

The array of employees.