Organization
Directory
Deductions
Documents
Management
Sandbox
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Development Guides
Organization
Directory
Read company directory and organization structure
GET
/
employer
/
directory
Copy
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
// Automatically fetches more pages as needed.
for await (const individualInDirectory of client.hris.directory.list()) {
console.log(individualInDirectory.id);
}
}
main();
Copy
{
"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
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Query Parameters
Number of employees to return (defaults to all)
Index to start from (defaults to 0)
Response
200 - application/json
The array of employees.
The department object.
The name of the department.
The legal first name of the individual.
A stable Finch id (UUID v4) for an individual in the company.
true
if the individual is an active employee or contractor at the company.
The legal last name of the individual.
The manager object.
A stable Finch id
(UUID v4) for an individual in the company.
The legal middle name of the individual.
Was this page helpful?
Copy
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
// Automatically fetches more pages as needed.
for await (const individualInDirectory of client.hris.directory.list()) {
console.log(individualInDirectory.id);
}
}
main();
Copy
{
"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
}
]
}