---
title: "Get Employee"
method: GET
path: "/hris/employees/{id}"
tags: ["Employees"]
---

# Get Employee

`GET /hris/employees/{id}`

Get Employee

## Path parameters

- `id` string, required

## Query parameters

- `raw` boolean
- `fields` string, nullable
- `filter` EmployeesOneFilter
  - `company_id` string — Company ID to filter on
- `pass_through` PassThroughQuery
  - `example_downstream_property` string — All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required
- `x-apideck-service-id` string

## Response `200`

Employees

- GetEmployeeResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `service` string, required — Apideck ID of service provider
  - `resource` string, required — Unified API resource name
  - `operation` string, required — Operation performed
  - `data` Employee, required
    - `id` string, nullable — A unique identifier for an object.
    - `downstream_id` string, nullable — The third-party API ID of original entity
    - `first_name` string, nullable — The first name of the person.
    - `last_name` string, nullable — The last name of the person.
    - `middle_name` string, nullable — Middle name of the person.
    - `display_name` string, nullable — The name used to display the employee, often a combination of their first and last names.
    - `preferred_name` string, nullable — The name the employee prefers to be addressed by, which may be different from their legal name.
    - `initials` string, nullable — The initials of the person, usually derived from their first, middle, and last names.
    - `salutation` string, nullable — A formal salutation for the person. For example, 'Mr', 'Mrs'
    - `title` string, nullable — The job title of the person.
    - `marital_status` string, nullable — The marital status of the employee.
    - `partner` Person
      - `id` string, nullable — A unique identifier for an object.
      - `first_name` string, nullable — The first name of the person.
      - `last_name` string, nullable — The last name of the person.
      - `middle_name` string, nullable — Middle name of the person.
      - `gender` 'male' | 'female' | 'unisex' | 'other' | 'not_specified', nullable — The gender represents the gender identity of a person.
      - `initials` string, nullable — Initials of the person
      - `birthday` string, date, nullable — Date of birth
      - `deceased_on` string, date, nullable — Date of death
      - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here.
    - `division` string, nullable — The division the person is currently in. Usually a collection of departments or teams or regions.
    - `division_id` string, nullable — Unique identifier of the division this employee belongs to.
    - `department` string, nullable — The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.
    - `department_id` string, nullable — Unique identifier of the department ID this employee belongs to.
    - `department_name` string, nullable — Name of the department this employee belongs to.
    - `team` Team, nullable — The team the person is currently in.
      - `id` string, nullable — The unique identifier of the team.
      - `name` string, nullable — The name of the team.
    - `company_id` string, nullable — The unique identifier of the company.
    - `company_name` string, nullable — The name of the company.
    - `employment_start_date` string, nullable — A Start Date is the date that the employee started working at the company
    - `employment_end_date` string, nullable — An End Date is the date that the employee ended working at the company
    - `leaving_reason` 'dismissed' | 'resigned' | 'redundancy' | 'retired' | 'other', nullable — The reason because the employment ended.
    - `employee_number` string, nullable — An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
    - `employment_status` 'active' | 'inactive' | 'terminated' | 'other', nullable — The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
    - `employment_role` object
      - `type` 'contractor' | 'employee' | 'freelance' | 'temp' | 'internship' | 'other', nullable — The type of employment relationship the employee has with the organization.
      - `sub_type` 'full_time' | 'part_time' | 'hourly' | 'other' | 'not_specified', nullable — The work schedule of the employee.
    - `ethnicity` string, nullable — The ethnicity of the employee
    - `manager` object
      - `id` string, nullable — A unique identifier for an object.
      - `name` string, nullable — The name of the manager, often a combination of their first and last names.
      - `first_name` string, nullable — The first name of the person.
      - `last_name` string, nullable — The last name of the person.
      - `email` string, email, nullable — The email address of the manager.
      - `employment_status` 'active' | 'inactive' | 'terminated' | 'other', nullable — The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
    - `direct_reports` string[], nullable — Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee.
    - `social_security_number` string, nullable — A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.
    - `birthday` string, date, nullable — The date of birth of the person.
    - `deceased_on` string, date, nullable — The date the person deceased.
    - `country_of_birth` string, nullable — Country code according to ISO 3166-1 alpha-2.
    - `description` string, nullable — A description of the object.
    - `gender` 'male' | 'female' | 'unisex' | 'other' | 'not_specified', nullable — The gender represents the gender identity of a person.
    - `pronouns` string, nullable — The preferred pronouns of the person.
    - `preferred_language` string, nullable — language code according to ISO 639-1. For the United States - EN
    - `languages` Language[]
    - `nationalities` Nationality[]
    - `photo_url` string, nullable — The URL of the photo of a person.
    - `timezone` string, nullable — The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.
    - `source` string, nullable — When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.
    - `source_id` string, nullable — Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).
    - `record_url` string, nullable
    - `jobs` EmployeeJob[], nullable
      - `id` string, nullable — A unique identifier for an object.
      - `employee_id` string, nullable — A unique identifier for an object.
      - `title` string, nullable — The job title of the person.
      - `role` string, nullable — The position and responsibilities of the person within the organization.
      - `start_date` string, date, nullable — The date on which the employee starts working in their current job role.
      - `end_date` string, date, nullable — The date on which the employee leaves or is expected to leave their current job role.
      - `compensation_rate` number, nullable — The rate of pay for the employee in their current job role.
      - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `payment_unit` 'hour' | 'week' | 'month' | 'year' | 'paycheck' | 'other', nullable — Unit of measurement for employee compensation.
      - `hired_at` string, date, nullable — The date on which the employee was hired by the organization
      - `is_primary` boolean, nullable — Indicates whether this the employee's primary job.
      - `is_manager` boolean, nullable — Indicates whether this the employee has a manager role.
      - `status` 'active' | 'inactive' | 'other', nullable — Indicates the status of the job.
      - `location` Address
        - `id` string, nullable — Unique identifier for the address.
        - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable — The type of address.
        - `string` string, nullable — The address string. Some APIs don't provide structured address data.
        - `name` string, nullable — The name of the address.
        - `line1` string, nullable — Line 1 of the address e.g. number, street, suite, apt #, etc.
        - `line2` string, nullable — Line 2 of the address
        - `line3` string, nullable — Line 3 of the address
        - `line4` string, nullable — Line 4 of the address
        - `line5` string, nullable — Line 5 of the address
        - `street_number` string, nullable — Street number
        - `city` string, nullable — Name of city.
        - `state` string, nullable — Name of state
        - `postal_code` string, nullable — Zip code or equivalent.
        - `country` string, nullable — country code according to ISO 3166-1 alpha-2.
        - `latitude` string, nullable — Latitude of the address
        - `longitude` string, nullable — Longitude of the address
        - `county` string, nullable — Address field that holds a sublocality, such as a county
        - `contact_name` string, nullable — Name of the contact person at the address
        - `salutation` string, nullable — Salutation of the contact person at the address
        - `phone_number` string, nullable — Phone number of the address
        - `fax` string, nullable — Fax number of the address
        - `email` string, nullable — Email address of the address
        - `website` string, nullable — Website of the address
        - `notes` string, nullable — Additional notes
        - `row_version` string, nullable — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
    - `compensations` EmployeeCompensation[], nullable
      - `id` string, nullable — A unique identifier for an object.
      - `job_id` string, nullable — The ID of the job to which the compensation belongs.
      - `rate` number, nullable — The amount paid per payment unit.
      - `payment_unit` 'hour' | 'week' | 'month' | 'year' | 'paycheck' | 'other', nullable — Unit of measurement for employee compensation.
      - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `flsa_status` 'exempt' | 'salaried-nonexempt' | 'nonexempt' | 'owner' | 'other', nullable — The FLSA status for this compensation.
      - `effective_date` string, nullable — The date on which a change to an employee's compensation takes effect.
      - `payment_frequency` 'weekly' | 'biweekly' | 'monthly' | 'pro-rata' | 'other', nullable — Frequency of employee compensation.
    - `works_remote` boolean, nullable — Indicates if the employee works from a remote location.
    - `addresses` Address[]
      - `id` string, nullable — Unique identifier for the address.
      - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable — The type of address.
      - `string` string, nullable — The address string. Some APIs don't provide structured address data.
      - `name` string, nullable — The name of the address.
      - `line1` string, nullable — Line 1 of the address e.g. number, street, suite, apt #, etc.
      - `line2` string, nullable — Line 2 of the address
      - `line3` string, nullable — Line 3 of the address
      - `line4` string, nullable — Line 4 of the address
      - `line5` string, nullable — Line 5 of the address
      - `street_number` string, nullable — Street number
      - `city` string, nullable — Name of city.
      - `state` string, nullable — Name of state
      - `postal_code` string, nullable — Zip code or equivalent.
      - `country` string, nullable — country code according to ISO 3166-1 alpha-2.
      - `latitude` string, nullable — Latitude of the address
      - `longitude` string, nullable — Longitude of the address
      - `county` string, nullable — Address field that holds a sublocality, such as a county
      - `contact_name` string, nullable — Name of the contact person at the address
      - `salutation` string, nullable — Salutation of the contact person at the address
      - `phone_number` string, nullable — Phone number of the address
      - `fax` string, nullable — Fax number of the address
      - `email` string, nullable — Email address of the address
      - `website` string, nullable — Website of the address
      - `notes` string, nullable — Additional notes
      - `row_version` string, nullable — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
    - `phone_numbers` PhoneNumber[]
      - `id` string, nullable — Unique identifier of the phone number
      - `country_code` string, nullable — The country code of the phone number, e.g. +1
      - `area_code` string, nullable — The area code of the phone number, e.g. 323
      - `number` string, required — The phone number
      - `extension` string, nullable — The extension of the phone number
      - `type` 'primary' | 'secondary' | 'home' | 'work' | 'office' | 'mobile' | 'assistant' | 'fax' | 'direct-dial-in' | 'personal' | 'billing' | 'other', nullable — The type of phone number
    - `emails` Email[]
      - `id` string, nullable — Unique identifier for the email address
      - `email` string, email, nullable, required — Email address
      - `type` 'primary' | 'secondary' | 'work' | 'personal' | 'billing' | 'other', nullable — Email type
    - `custom_fields` CustomField[]
      - union
        - object
          - `id` string, nullable, required — Unique identifier for the custom field.
          - `name` string, nullable — Name of the custom field.
          - `ref_name` string, nullable — Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it.
          - `description` string, nullable — More information about the custom field
          - `value` union
            - string, nullable
            - number, nullable
            - boolean, nullable
            - object, nullable
            - union[]
              - …
        - object
          - `id` string, nullable — Unique identifier for the custom field.
          - `name` string, nullable, required — Name of the custom field.
          - `ref_name` string, nullable — Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it.
          - `description` string, nullable — More information about the custom field
          - `value` union
            - string, nullable
            - number, nullable
            - boolean, nullable
            - object, nullable
            - union[]
              - …
    - `social_links` SocialLink[]
      - `id` string, nullable — Unique identifier of the social link
      - `url` string, required — URL of the social link, e.g. https://www.twitter.com/apideck
      - `type` string, nullable — Type of the social link, e.g. twitter
    - `bank_accounts` BankAccount[]
      - `bank_name` string, nullable — The name of the bank or financial institution
      - `account_number` string, nullable — The bank account number
      - `account_name` string, nullable — The name of the bank account
      - `account_type` 'bank_account' | 'credit_card' | 'other', nullable — The type of bank account.
      - `iban` string, nullable — International Bank Account Number
      - `bic` string, nullable — Bank Identifier Code / SWIFT Code
      - `routing_number` string, nullable — Bank routing number (US)
      - `bsb_number` string, nullable — Bank State Branch number (Australia/New Zealand)
      - `branch_identifier` string, nullable — Bank branch identifier
      - `bank_code` string, nullable — Bank code assigned by central bank
      - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `country` string, nullable — Country code according to ISO 3166-1 alpha-2.
    - `tax_code` string, nullable
    - `tax_id` string, nullable
    - `dietary_preference` string, nullable — Indicate the employee's dietary preference.
    - `food_allergies` string[], nullable — Indicate the employee's food allergies.
    - `probation_period` object
      - `start_date` string, date, nullable — The date that the employee started their probation period at the company.
      - `end_date` string, date, nullable — The date that the employee ended their probation period at the company.
    - `tags` string[], nullable
    - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here.
    - `row_version` string, nullable — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
    - `deleted` boolean, nullable — Flag to indicate if the object is deleted.
    - `updated_by` string, nullable — The user who last updated the object.
    - `created_by` string, nullable — The user who created the object.
    - `updated_at` string, date-time, nullable — The date and time when the object was last updated.
    - `created_at` string, date-time, nullable — The date and time when the object was created.
    - `pass_through` object[] — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
      - `service_id` string, required — Identifier for the service to which this pass_through should be applied.
      - `operation_id` string — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request.
      - `extend_object` object — Simple object allowing any properties for direct extension.
      - `extend_paths` object[] — Array of objects for structured data modifications via paths.
        - `path` string, required — JSONPath string specifying where to apply the value.
        - `value` unknown, required
  - `meta` Meta — Response metadata
    - `items_on_page` integer — Number of items returned in the data property of the response
    - `cursors` object — Cursors to navigate to previous or next pages through the API
      - `previous` string, nullable — Cursor to navigate to the previous page of results through the API
      - `current` string, nullable — Cursor to navigate to the current page of results through the API
      - `next` string, nullable — Cursor to navigate to the next page of results through the API
    - `total_count` integer — Number of records available in total for this resource
    - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200.
      - `type` string — Discriminator for the warning kind.
      - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available.
      - `error` string, nullable — Short error description from the downstream provider, when available.
      - `operation` string, nullable — Identifier of the workflow step that failed.
      - `message` string, nullable — Detailed message from the downstream provider, when available.
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

---

[API](https://skmtc.net/apideck-libraries/apis/hris-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/hris-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/hris-api/revisions/e35f311981db/schema)
