POST
/
forward
import Finch from '@tryfinch/finch-api';

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

async function main() {
  const response = await client.requestForwarding.forward({
    method: 'POST',
    route: '/people/search',
    headers: { 'content-type': 'application/json' },
    params: { showInactive: true, humanReadable: true },
  });

  console.log(response.data);
}

main();
{
  "request": {
    "method": "POST",
    "route": "/people/search",
    "headers": {
      "content-type": "application/json"
    },
    "params": {
      "showInactive": true,
      "humanReadable": true
    },
    "data": null
  },
  "headers": {
    "date": "Sun, 17 Sep 2023 21:27:25 GMT",
    "content-type": "application/json"
  },
  "statusCode": 200,
  "data": "{\"employees\":[{\"/work/custom/field_1693264321143\":{\"value\":580192},\"fullName\":\"Anna Gibbons\",\"/payroll/employment/siteWorkingPattern\":{\"value\":{\"workingPatternType\":\"partial_week\",\"days\":{\"sunday\":false,\"tuesday\":true,\"wednesday\":true,\"monday\":true,\"friday\":true,\"thursday\":true,\"saturday\":false},\"hoursPerDay\":9,\"workingPatternId\":null}},\"/about/avatar\":{\"value\":\"https://media-process.hibob.com/image/upload/v1/hibob/demo-avatar/demo_employee/images/UiRYuQQyDc4sLbYzFFtN_59.jpg?__cld_token__=exp=4795680381~acl=*%2fhibob%2fdemo-avatar%2fdemo_employee%2fimages%2fUiRYuQQyDc4sLbYzFFtN_59.jpg*~hmac=07e5aff698027029ebbb4d8cb067db044ec46a86f9bf71430c53cc590f9c07a6\"},\"displayName\":\"Anna Gibbons\",\"/work/reportsTo/email\":{\"value\":\"joshua.tyler_632127@samplebob.com\"},\"/payroll/employment/activeEffectiveDate\":{\"value\":\"2015-03-03\"},\"payroll\":{\"employment\":{\"standardWorkingPattern\":null,\"fte\":100,\"type\":null,\"flsaCode\":null,\"actualWorkingPattern\":{\"workingPatternType\":\"partial_week\",\"days\":{\"sunday\":false,\"tuesday\":true,\"wednesday\":true,\"monday\":true,\"friday\":true,\"thursday\":true,\"saturday\":false},\"hoursPerDay\":9,\"workingPatternId\":null},\"contract\":\"Full time\",\"customColumns\":{\"column_1693433488092\":null,\"column_1693419526345\":null},\"calendarId\":null,\"salaryPayType\":null,\"workingPattern\":null,\"activeEffectiveDate\":\"2015-03-03\",\"weeklyHours\":45,\"siteWorkingPattern\":{\"workingPatternType\":\"partial_week\",\"days\":{\"sunday\":false,\"tuesday\":true,\"wednesday\":true,\"monday\":true,\"friday\":true,\"thursday\":true,\"saturday\":false},\"hoursPerDay\":9,\"workingPatternId\":null}}},\"/root/firstName\":{\"value\":\"Anna\"},\"/work/employeeIdInCompany\":{\"value\":38},\"/work/tenureDurationYears\":{\"value\":8.545},\"/about/foodPreferences\":{\"value\":[]},\"/work/site\":{\"value\":\"New York (Demo)\"},\"/work/tenureYears\":{\"value\":9},\"creationDateTime\":\"2023-07-13T06:37:04.94395\",\"/about/hobbies\":{\"value\":[\"theatre\",\"film\",\"music\"]},\"/root/email\":{\"value\":\"anna.gibbons_632127@samplebob.com\"},\"/work/title\":{\"value\":\"Sales Manager\"},\"employee\":{\"payrollManager\":null,\"hrbp\":null,\"itAdmin\":null,\"buddy\":null},\"work\":{\"shortStartDate\":\"03-03\",\"startDate\":\"2015-03-03\",\"manager\":\"3145813558047015811\",\"tenureDuration\":{\"periodISO\":\"P8Y6M16D\",\"sortFactor\":3076,\"humanize\":\"8 years, 6 months and 16 days\"},\"custom\":{\"field_1693264337015\":580192,\"field_1693264321143\":580192},\"durationOfEmployment\":{\"periodISO\":\"P8Y6M16D\",\"sortFactor\":3076,\"humanize\":\"8 years, 6 months and 16 days\"},\"reportsToIdInCompany\":27,\"employeeIdInCompany\":38,\"reportsTo\":{\"displayName\":\"Joshua Tyler\",\"email\":\"joshua.tyler_632127@samplebob.com\",\"surname\":\"Tyler\",\"firstName\":\"Joshua\",\"id\":\"3145813558047015811\"},\"indirectReports\":null,\"siteId\":2477371,\"tenureDurationYears\":8.545,\"department\":\"Sales\",\"tenureYears\":9,\"isManager\":false,\"title\":\"Sales Manager\",\"site\":\"New York (Demo)\",\"activeEffectiveDate\":\"2015-03-03\",\"directReports\":null,\"secondLevelManager\":\"3145813528661721978\",\"daysOfPreviousService\":0,\"yearsOfService\":8.545},\"/payroll/employment/weeklyHours\":{\"value\":45},\"/root/creationDateTime\":{\"value\":\"2023-07-13T06:37:04.94395\"},\"avatarUrl\":\"https://media-process.hibob.com/image/upload/v1/hibob/demo-avatar/demo_employee/images/UiRYuQQyDc4sLbYzFFtN_59.jpg?__cld_token__=exp=4795680381~acl=*%2fhibob%2fdemo-avatar%2fdemo_employee%2fimages%2fUiRYuQQyDc4sLbYzFFtN_59.jpg*~hmac=07e5aff698027029ebbb4d8cb067db044ec46a86f9bf71430c53cc590f9c07a6\",\"secondName\":null,\"/work/startDate\":{\"value\":\"2015-03-03\"},\"about\":{\"foodPreferences\":[],\"socialData\":{\"linkedin\":null,\"twitter\":null,\"facebook\":null},\"superpowers\":[\"proof reading\"],\"hobbies\":[\"theatre\",\"film\",\"music\"],\"about\":\"I dont have a life story, my story is my life \",\"avatar\":\"https://media-process.hibob.com/image/upload/v1/hibob/demo-avatar/demo_employee/images/UiRYuQQyDc4sLbYzFFtN_59.jpg?__cld_token__=exp=4795680381~acl=*%2fhibob%2fdemo-avatar%2fdemo_employee%2fimages%2fUiRYuQQyDc4sLbYzFFtN_59.jpg*~hmac=07e5aff698027029ebbb4d8cb067db044ec46a86f9bf71430c53cc590f9c07a6\"},\"/root/fullName\":{\"value\":\"Anna Gibbons\"},\"/payroll/employment/contract\":{\"value\":\"Full time\"},\"/payroll/employment/actualWorkingPattern\":{\"value\":{\"workingPatternType\":\"partial_week\",\"days\":{\"sunday\":false,\"tuesday\":true,\"wednesday\":true,\"monday\":true,\"friday\":true,\"thursday\":true,\"saturday\":false},\"hoursPerDay\":9,\"workingPatternId\":null}},\"companyId\":632127,\"/root/coverImageUrl\":{\"value\":\"https://media-process.hibob.com/image/upload/v1/hibob/public-image/cover/default_cover_image.png?token=X19jbGRfdG9rZW5fXz1leHA9NDg0OTgzNjczOX5hY2w9KiUyZmhpYm9iJTJmcHVibGljLWltYWdlJTJmY292ZXIlMmZkZWZhdWx0X2NvdmVyX2ltYWdlLnBuZyp+aG1hYz0zMjY3NjE4ZDQ1MzZjZjE3MWFiM2Y2MzJlY2JmZmQ5MWZkYTRmY2FmOGY3MDExYjllNmZlZTI4Njc0MzZlN2M5&vendor=cloudinary\"},\"/work/secondLevelManager\":{\"value\":\"3145813528661721978\"},\"/work/yearsOfService\":{\"value\":8.545},\"/work/daysOfPreviousService\":{\"value\":0},\"/about/about\":{\"value\":\"I dont have a life story, my story is my life \"},\"/root/avatarUrl\":{\"value\":\"https://media-process.hibob.com/image/upload/v1/hibob/demo-avatar/demo_employee/images/UiRYuQQyDc4sLbYzFFtN_59.jpg?__cld_token__=exp=4795680381~acl=*%2fhibob%2fdemo-avatar%2fdemo_employee%2fimages%2fUiRYuQQyDc4sLbYzFFtN_59.jpg*~hmac=07e5aff698027029ebbb4d8cb067db044ec46a86f9bf71430c53cc590f9c07a6\"},\"/root/surname\":{\"value\":\"Gibbons\"},\"/work/shortStartDate\":{\"value\":\"03-03\"},\"/work/activeEffectiveDate\":{\"value\":\"2015-03-03\"},\"/root/id\":{\"value\":\"3145813590838084494\"},\"email\":\"anna.gibbons_632127@samplebob.com\",\"/work/manager\":{\"value\":\"3145813558047015811\"},\"surname\":\"Gibbons\",\"/work/reportsTo\":{\"value\":{\"displayName\":\"Joshua Tyler\",\"email\":\"joshua.tyler_632127@samplebob.com\",\"surname\":\"Tyler\",\"firstName\":\"Joshua\",\"id\":\"3145813558047015811\"}},\"/root/displayName\":{\"value\":\"Anna Gibbons\"},\"/root/companyId\":{\"value\":632127},\"/payroll/employment/fte\":{\"value\":100},\"/work/department\":{\"value\":\"Sales\"},\"/work/isManager\":{\"value\":false},\"/work/custom/field_1693264337015\":{\"value\":580192},\"/work/reportsToIdInCompany\":{\"value\":27},\"/work/tenureDuration\":{\"value\":{\"periodISO\":\"P8Y6M16D\",\"sortFactor\":3076,\"humanize\":\"8 years, 6 months and 16 days\"}},\"coverImageUrl\":\"https://media-process.hibob.com/image/upload/v1/hibob/public-image/cover/default_cover_image.png?token=X19jbGRfdG9rZW5fXz1leHA9NDg0OTgzNjczOX5hY2w9KiUyZmhpYm9iJTJmcHVibGljLWltYWdlJTJmY292ZXIlMmZkZWZhdWx0X2NvdmVyX2ltYWdlLnBuZyp+aG1hYz0zMjY3NjE4ZDQ1MzZjZjE3MWFiM2Y2MzJlY2JmZmQ5MWZkYTRmY2FmOGY3MDExYjllNmZlZTI4Njc0MzZlN2M5&vendor=cloudinary\",\"/about/superpowers\":{\"value\":[\"proof reading\"]},\"/work/siteId\":{\"value\":2477371},\"id\":\"3145813590838084494\",\"firstName\":\"Anna\",\"/work/durationOfEmployment\":{\"value\":{\"periodISO\":\"P8Y6M16D\",\"sortFactor\":3076,\"humanize\":\"8 years, 6 months and 16 days\"}}}]}"
}

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

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

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

Body

application/json

Forward Request Body

Response

200 - application/json
Successful response

The response is of type object.