Unified.to · Schema

HrisEmployee

HrisEmployee schema from Unified.to API

IntegrationsUnified API

Properties

Name Type Description
id string
created_at string
updated_at string
name string
first_name string
last_name string
emails object
title string
manager_id string
employment_status string
gender string
telephones object
date_of_birth string
employee_number string
hired_at string
terminated_at string
termination_reason string
marital_status string
employment_type string
address object
language_locale string
currency string
timezone string
image_url string
company_id string
pronouns string
employee_roles object
compensation object
salutation string
bio string
ssn_sin string
groups object
locations object
metadata object
storage_quota_allocated number
storage_quota_used number
storage_quota_available number
relationships object
has_mfa boolean
timeoff_days_total number
timeoff_days_used number
raw object
View JSON Schema on GitHub

JSON Schema

unified-to-hris-employee-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-hris-employee-schema.json",
  "title": "HrisEmployee",
  "description": "HrisEmployee schema from Unified.to API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "emails": {
      "$ref": "#/components/schemas/property_HrisEmployee_emails"
    },
    "title": {
      "type": "string"
    },
    "manager_id": {
      "type": "string"
    },
    "employment_status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "gender": {
      "type": "string",
      "enum": [
        "MALE",
        "FEMALE",
        "INTERSEX",
        "TRANS",
        "NON_BINARY"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "telephones": {
      "$ref": "#/components/schemas/property_HrisEmployee_telephones"
    },
    "date_of_birth": {
      "type": "string",
      "format": "date-time"
    },
    "employee_number": {
      "type": "string"
    },
    "hired_at": {
      "type": "string",
      "format": "date-time"
    },
    "terminated_at": {
      "type": "string",
      "format": "date-time"
    },
    "termination_reason": {
      "type": "string"
    },
    "marital_status": {
      "type": "string",
      "enum": [
        "MARRIED",
        "SINGLE"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "employment_type": {
      "type": "string",
      "enum": [
        "FULL_TIME",
        "PART_TIME",
        "CONTRACTOR",
        "INTERN",
        "CONSULTANT",
        "VOLUNTEER",
        "CASUAL",
        "SEASONAL",
        "FREELANCE",
        "OTHER"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "address": {
      "$ref": "#/components/schemas/property_HrisEmployee_address"
    },
    "language_locale": {
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "timezone": {
      "type": "string"
    },
    "image_url": {
      "type": "string"
    },
    "company_id": {
      "type": "string"
    },
    "pronouns": {
      "type": "string"
    },
    "employee_roles": {
      "$ref": "#/components/schemas/property_HrisEmployee_employee_roles"
    },
    "compensation": {
      "$ref": "#/components/schemas/property_HrisEmployee_compensation"
    },
    "salutation": {
      "type": "string"
    },
    "bio": {
      "type": "string"
    },
    "ssn_sin": {
      "type": "string"
    },
    "groups": {
      "$ref": "#/components/schemas/property_HrisEmployee_groups"
    },
    "locations": {
      "$ref": "#/components/schemas/property_HrisEmployee_locations"
    },
    "metadata": {
      "$ref": "#/components/schemas/property_HrisEmployee_metadata"
    },
    "storage_quota_allocated": {
      "type": "number"
    },
    "storage_quota_used": {
      "type": "number"
    },
    "storage_quota_available": {
      "type": "number"
    },
    "relationships": {
      "$ref": "#/components/schemas/property_HrisEmployee_relationships"
    },
    "has_mfa": {
      "type": "boolean"
    },
    "timeoff_days_total": {
      "type": "number"
    },
    "timeoff_days_used": {
      "type": "number"
    },
    "raw": {
      "type": "object",
      "additionalProperties": true
    }
  }
}