Persons

HR Works Persons API

Sync permissioned persons data with HR Works through Apideck's unified API. One integration, instant access to the governed data your team needs.

In Apideck, this resource is called Employees (API: employees)

Supported Operations for HR Works Persons

List, Get operations available through our unified API

list

get

create

update

delete

Supported Fields

24 fields

Fields available for HR Works Persons

idfirst_namelast_nametitledepartment_iddepartment_nameemployment_start_dateemployment_end_dateemployee_numberemployment_statusemployment_rolemanagersocial_security_numberbirthdaygender+9 more

API Model Preview

Sample response structure for persons

{
  "id": "12345",
  "first_name": "Example First Name",
  "last_name": "Example Last Name",
  "title": "Example Title",
  "department_id": "12345",
  "department_name": "Example Department Name",
  "employment_start_date": "2024-01-15",
  "employment_end_date": "2024-01-15",
  "employee_number": 10,
  "employment_status": "active",
  "employment_role": "string",
  "manager": "string",
  "social_security_number": 10,
  "birthday": "string",
  "gender": "string",
  "nationalities": "string",
  "p
  ...

Quick Start Example

Start syncing HR Works persons in minutes

Node.js

import { Apideck } from '@apideck/unify'

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: 'YOUR_APP_ID',
  consumerId: 'YOUR_CONSUMER_ID'
})

// List persons from HR Works
const result = await apideck.hris.employees.list({
  serviceId: 'hr-works'
})

for await (const page of result) {
  console.log(page)
}
// Returns unified persons data

View full SDK documentation

Popular Use Cases