- Changelog
- API Status
- GETGet All Deductions
- POSTRegister Deduction
- POSTCreate Deduction
- GETGet Deduction
- POSTUpdate Deduction
- GETGet Enrolled Individuals
- GETGet Deductions for Individuals
- POSTEnroll Individuals in Deductions
- DELUnenroll Individuals from Deductions
- POSTCreate Access Token
- GETProviders
- GETIntrospect
- POSTDisconnect
- POSTRequest Forwarding
- GETList All Automated Jobs
- POSTEnqueue a New Automated Job
- GETRetrieve an Automated Job
- GETRetrieve a Manual Job
- 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
Deductions
Management
Sandbox
Directory
Read company directory and organization structure
Please use your Access Token
Header used to specify the version for a given API request. Current version is 2020-09-17.
Number of employees to return (defaults to all)
Index to start from (defaults to 0)
curl --request GET \
--url https://api.tryfinch.com/employer/directory \
--header 'Authorization: Bearer <token>' \
--header 'Finch-API-Version: <finch-api-version>'
{
"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
The total number of elements for the entire query (not just the given page)
The current start index of the returned list of elements
The array of employees.
A stable Finch id (UUID v4) for an individual in the company.
The legal first name of the individual.
The legal middle name of the individual.
The legal last name of the individual.
The manager object.
A stable Finch id
(UUID v4) for an individual in the company.
The department object.
The name of the department.
true
if the individual is an active employee or contractor at the company.
Was this page helpful?
curl --request GET \
--url https://api.tryfinch.com/employer/directory \
--header 'Authorization: Bearer <token>' \
--header 'Finch-API-Version: <finch-api-version>'
{
"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
}
]
}