Skip to main content
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": {
    "offset": 123,
    "count": 123
  },
  "individuals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "manager": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "department": {
        "name": "<string>"
      },
      "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

entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access.

Required array length: 1 element
Example:
["550e8400-e29b-41d4-a716-446655440000"]
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
Paging · object
required
individuals
object[]
required

The array of employees.