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

const finch = new Finch();

async function main() {
  // Automatically fetches more pages as needed.
  for await (const individualInDirectory of finch.hris.directory.list()) {
    console.log(individualInDirectory.id);
  }
}

main();
{
  "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
headerrequired

Please use your Access Token

Headers

Finch-API-Version
string
default: 2020-09-17required

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

200 - application/json
paging
object
individuals
object[]

The array of employees.