Merge · JSON Structure

Hris Api Employee Structure

Represents an employee record from a connected HRIS integration in the Merge Unified API.

Type: object Properties: 21
IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Employee is a JSON Structure definition published by Merge, describing 21 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id remote_id employee_number first_name last_name display_full_name work_email personal_email mobile_phone_number date_of_birth start_date termination_date employment_status manager company team pay_group groups remote_was_deleted created_at modified_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-structure/hris-api-employee-structure.json",
  "name": "Employee",
  "description": "Represents an employee record from a connected HRIS integration in the Merge Unified API.",
  "type": "object",
  "properties": {
    "id": { "type": "uuid", "description": "The unique Merge-generated identifier." },
    "remote_id": { "type": "string", "description": "The third-party ID of this employee." },
    "employee_number": { "type": "string", "description": "The employee's number in the organization." },
    "first_name": { "type": "string", "description": "The employee's first name." },
    "last_name": { "type": "string", "description": "The employee's last name." },
    "display_full_name": { "type": "string", "description": "The employee's full display name." },
    "work_email": { "type": "string", "description": "The employee's work email address." },
    "personal_email": { "type": "string", "description": "The employee's personal email address." },
    "mobile_phone_number": { "type": "string", "description": "The employee's mobile phone number." },
    "date_of_birth": { "type": "date", "description": "The employee's date of birth." },
    "start_date": { "type": "datetime", "description": "The date the employee started working." },
    "termination_date": { "type": "datetime", "description": "The date the employee was terminated." },
    "employment_status": { "type": "string", "enum": ["ACTIVE", "PENDING", "INACTIVE"], "description": "Current employment status." },
    "manager": { "type": "uuid", "description": "The Merge ID of this employee's manager." },
    "company": { "type": "uuid", "description": "The Merge ID of the employee's company." },
    "team": { "type": "uuid", "description": "The Merge ID of the employee's team." },
    "pay_group": { "type": "uuid", "description": "The Merge ID of the employee's pay group." },
    "groups": { "type": "array", "items": { "type": "uuid" }, "description": "Groups this employee belongs to." },
    "remote_was_deleted": { "type": "boolean", "description": "Whether the record was deleted in the third-party platform." },
    "created_at": { "type": "datetime", "description": "When the Merge record was created." },
    "modified_at": { "type": "datetime", "description": "When the Merge record was last modified." }
  }
}