Person Detail

CIPHR Person Detail API

Sync permissioned person detail data with CIPHR 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 CIPHR Person Detail

List, Get operations available through our unified API

list

get

create

update

delete

Supported Fields

17 fields

Fields available for CIPHR Person Detail

idfirst_namelast_namepreferred_namesalutationemployment_start_dateemployment_end_dateemployee_numberemployment_statussocial_security_numberbirthdaygendercompensationsaddressesemails+2 more

API Model Preview

Sample response structure for person detail

{
  "id": "12345",
  "first_name": "Example First Name",
  "last_name": "Example Last Name",
  "preferred_name": "Example Preferred Name",
  "salutation": "string",
  "employment_start_date": "2024-01-15",
  "employment_end_date": "2024-01-15",
  "employee_number": 10,
  "employment_status": "active",
  "social_security_number": 10,
  "birthday": "string",
  "gender": "string",
  "compensations": "string",
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spr
  ...

Quick Start Example

Start syncing CIPHR person detail 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 person detail from CIPHR
const result = await apideck.hris.employees.list({
  serviceId: 'ciphr'
})

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

View full SDK documentation

Popular Use Cases