Merge
Merge HRIS API

Merge HRIS API provides a unified interface to integrate every HR, payroll, and SCIM directory system with one API. It normalizes data across 80+ HR platforms including Workday, BambooHR, Gusto, Rippling, ADP, and many more, enabling developers to deliver integrations in days instead of quarters.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: HRIS
  version: 1.0.0
paths:
  /hris/v1/bank-info:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `BankInfo` objects.{/* BEGIN_HRIS_BANKINFO_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+WYbW/iOBDHvwrySwRkKcvtFem04qFAH0g5oLvbW1XR4AyJwbGD47TAar/7KQQq2OuttqqPh+MdMeO/k59nPDP+Riho9KSakwrxFYtIjgTSRU4qpAZicilGkuQIhMyGAFc2zuMZyZEoDkOpNLpNhtyN2gpHpEKsAJWH+ViwEUPXSswtJjR6CjSTIrKep+VHy3kkRzgTE3SrlMpY6J8JpYZ5SC1/eEz+jjTJkRCiSPtKxp7fw2mM0U81k/fhGKDQwPMuaLA25udVKvDSWPLmLnLU6DZAQwM10uQTV2v5WodRxbJ85GFhuW7BxUcLhQVKM8oxssql87MP5+X8SmW5+kfH438Us+PpUA4/ZB2PcgfibGdAZ/bg8skee+/t+vuZvbgr24vJwh5P3mUdD7KdQad8O7gv3TaqxdsXDJz+b1/OP9UatSs7SxcXJXt8/2QPaLEzoJPh4rJ01aJPV+0/Z/bi/qzTuCvZg4vyVUsWb+u9qFPvyU61UCA5srmTpPL12+bAykFqCkH7uG18GYCHG1DSfYCQ5cN4yBktRKUCBLCQAp6iApWBFaDLwFqJOf1pDAqdG+lJp3l//pc3Dgrj0FvvAJPiGT+pkAu7XbXrF41tX6g+AuMw5EgqWsX4Dwcmla9k5UqOiIMhKpIjQxATRyRfliMYhFzOMfmpMJAanWTDtp+cELSfDMlYM+GthR4So2nMFLpdUBCgRpUs+PA99xLDug+KM0MMV2Lt3ibFQij+t/QaMB9JRQ3h63LQI6mCtepuyK0H9DzEvYFsAtVSMeBmSD7L/eeOuCdcCiNfIwSGcK3lVrgOPGTTIea+GWMbGMd5pt0zG7+prNPuHTjHbXY5Egs2jROwKHRStryeJxvKoWGWieQJHYTt3mepJpFhiKnobjD+OqvXookDAGEIzUpsKz8cQJlHkyoUXQf0bk/Cy77kj+iadTsWLUWPK3qNIb1GMZZmgS4lnegAcvSbyNzElIIZMkup3QTufryoC/M6hBqYMORKMKep3k796Bej862oqI8zc5x8nO2+kf2B1H4LuoSCDMweYqnmqcJUZmGGS81DDOWdHpFcUqbnxiI/ldu6CrxpBcWmK07RbVGGHI31yCs1p0opRuv6+6ga5dfy4yBcmBs+RFPRI+/o+tVuph8vHSG9sTPU3G1rbsVxjX6RXvPdvkrGl/o7A0fgQDEbdabdy6wdxAzIgWICtVM80cxyd93KdJWhJu7uunXaeTqh2UNw56Z5Oh5C+/dp97i4Gk/UyR2f8UTzORU9ZrT/jvHh+9/eXrbGlSAAAA=="
        /></Footer>{/* END_HRIS_BANKINFO_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_bankInfo
      parameters:
        - name: account_type
          in: query
          description: |+
            If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')

          required: false
          schema:
            $ref: '#/components/schemas/BankInfoGetParametersAccountType'
        - name: bank_name
          in: query
          description: If provided, will only return BankInfo's with this bank name.
          required: false
          schema:
            type: string
        - name: created_after
          in: query
          description: If provided, will only return objects created after this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          description: If provided, will only return objects created before this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          description: The pagination cursor value.
          required: false
          schema:
            type: string
        - name: employee_id
          in: query
          description: If provided, will only return bank accounts for this employee.
          required: false
          schema:
            type: string
        - name: expand
          in: query
          description: >-
            Which relations should be returned in expanded form. Multiple relation names should be comma separated
            without spaces.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BankInfoGetParametersExpandSchemaItems'
        - name: include_deleted_data
          in: query
          description: >-
            Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion
            detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn
            more](https://docs.merge.dev/integrations/hris/supported-features/).
          required: false
          schema:
            type: boolean
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: modified_after
          in: query
          description: If provided, only objects synced by Merge after this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: modified_before
          in: query
          description: If provided, only objects synced by Merge before this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: order_by
          in: query
          description: >-
            Overrides the default ordering for this endpoint. Possible values include: remote_created_at,
            -remote_created_at.
          required: false
          schema:
            $ref: '#/components/schemas/BankInfoGetParametersOrderBy'
        - name: page_size
          in: query
          description: Number of results to return per page. The maximum limit is 100.
          required: false
          schema:
            type: integer
        - name: remote_fields
          in: query
          description: Deprecated. Use show_enum_origins.
          required: false
          schema:
            $ref: '#/components/schemas/BankInfoGetParametersRemoteFields'
        - name: remote_id
          in: query
          description: The API provider's ID for the given object.
          required: false
          schema:
            type: string
        - name: show_enum_origins
          in: query
          description: >-
            A comma separated list of enum field names for which you'd like the original values to be returned, instead
            of Merge's normalized enum values. [Learn
            more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
          required: false
          schema:
            $ref: '#/components/schemas/BankInfoGetParametersShowEnumOrigins'
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBankInfoList'
  /hris/v1/bank-info/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: >-
        Returns a `BankInfo` object with the given `id`.{/* BEGIN_HRIS_BANKINFO_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+WYbW/iOBDHvwrySwRkKcvtFem04qFAH0g5oLvbW1XR4AyJwbGD47TAar/7KQQq2OuttqqPh+MdMeO/k59nPDP+Riho9KSakwrxFYtIjgTSRU4qpAZicilGkuQIhMyGAFc2zuMZyZEoDkOpNLpNhtyN2gpHpEKsAJWH+ViwEUPXSswtJjR6CjSTIrKep+VHy3kkRzgTE3SrlMpY6J8JpYZ5SC1/eEz+jjTJkRCiSPtKxp7fw2mM0U81k/fhGKDQwPMuaLA25udVKvDSWPLmLnLU6DZAQwM10uQTV2v5WodRxbJ85GFhuW7BxUcLhQVKM8oxssql87MP5+X8SmW5+kfH438Us+PpUA4/ZB2PcgfibGdAZ/bg8skee+/t+vuZvbgr24vJwh5P3mUdD7KdQad8O7gv3TaqxdsXDJz+b1/OP9UatSs7SxcXJXt8/2QPaLEzoJPh4rJ01aJPV+0/Z/bi/qzTuCvZg4vyVUsWb+u9qFPvyU61UCA5srmTpPL12+bAykFqCkH7uG18GYCHG1DSfYCQ5cN4yBktRKUCBLCQAp6iApWBFaDLwFqJOf1pDAqdG+lJp3l//pc3Dgrj0FvvAJPiGT+pkAu7XbXrF41tX6g+AuMw5EgqWsX4Dwcmla9k5UqOiIMhKpIjQxATRyRfliMYhFzOMfmpMJAanWTDtp+cELSfDMlYM+GthR4So2nMFLpdUBCgRpUs+PA99xLDug+KM0MMV2Lt3ibFQij+t/QaMB9JRQ3h63LQI6mCtepuyK0H9DzEvYFsAtVSMeBmSD7L/eeOuCdcCiNfIwSGcK3lVrgOPGTTIea+GWMbGMd5pt0zG7+prNPuHTjHbXY5Egs2jROwKHRStryeJxvKoWGWieQJHYTt3mepJpFhiKnobjD+OqvXookDAGEIzUpsKz8cQJlHkyoUXQf0bk/Cy77kj+iadTsWLUWPK3qNIb1GMZZmgS4lnegAcvSbyNzElIIZMkup3QTufryoC/M6hBqYMORKMKep3k796Bej862oqI8zc5x8nO2+kf2B1H4LuoSCDMweYqnmqcJUZmGGS81DDOWdHpFcUqbnxiI/ldu6CrxpBcWmK07RbVGGHI31yCs1p0opRuv6+6ga5dfy4yBcmBs+RFPRI+/o+tVuph8vHSG9sTPU3G1rbsVxjX6RXvPdvkrGl/o7A0fgQDEbdabdy6wdxAzIgWICtVM80cxyd93KdJWhJu7uunXaeTqh2UNw56Z5Oh5C+/dp97i4Gk/UyR2f8UTzORU9ZrT/jvHh+9/eXrbGlSAAAA=="
        /></Footer>{/* END_HRIS_BANKINFO_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_bankInfo
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: >-
            Which relations should be returned in expanded form. Multiple relation names should be comma separated
            without spaces.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BankInfoIdGetParametersExpandSchemaItems'
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: remote_fields
          in: query
          description: Deprecated. Use show_enum_origins.
          required: false
          schema:
            $ref: '#/components/schemas/BankInfoIdGetParametersRemoteFields'
        - name: show_enum_origins
          in: query
          description: >-
            A comma separated list of enum field names for which you'd like the original values to be returned, instead
            of Merge's normalized enum values. [Learn
            more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
          required: false
          schema:
            $ref: '#/components/schemas/BankInfoIdGetParametersShowEnumOrigins'
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankInfo'
  /hris/v1/benefits:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `Benefit` objects.{/* BEGIN_HRIS_BENEFIT_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA91X8W/aOBj9V5B/RIEcZdyuSNMETQvtRsgxeltvqqwP5yMYHDs4TmmY9r+fQtIq3LpJuwaq3W+J833Pznsvz84XwsBgoHRKumSheUwsEiofBemSPkqcc0MsAhF3IcSihN6dEIvESRQpbdC/4Cj8eKhxTrrEDlEH2Egkn3P07azc5tJgoMFwJWP7sa0x3/URiwguV+j3GFOJND8CygsbkFf+6zZ7HGeLjSCOzUKrJFhMcJ1g/EPMbD0CQ5QGRMMHA3apv6FzgKfGspX7KNCg74ABBw2y7BWLuRbGRHHXthcoouZu3qaPdzZKG7ThTGBsd9qnJ69PO40CZTf7WxqIN636cj1Ts9d1GjBBIamPpuzenV5u3GXwyj17de9urzvudrV1l6vf6jSA+mg66oynN+2x02uNnyigH37/dPpX3+lfuXW2PW+7y5uNO2Wt0ZStZtvL9tWAba6Gf96725uTkXPddqfnnauBao3PJvHobKJGvWaTWKSsJOl+/lIeKAzSc7zaR6VXc6UZ1ly12W+7DCHAEj25IhDxRpTMBGfNuN2EELZKwiZuMhXaIfoc7J7j0UdY6qoN/bBOQGMzksGDEFzJRxVIl5y7w557du7sW6J3B1zATCDpGp3gNz4m3c9klhufRgIkNWmExCJMhRHIlDIljeazZDeJRTCMhEoRS5ffKdG0gM2GpE99MFlXpNUd91FTmfFnEY2hMpg9hf07GoFZZN+dAW3y7tusYJ1wjb4HGkI0qLMXuP1qPSmNMKih5kGqlRAV6bLDLMSg71WgjqcICEaZ8svc73N7QC77EM6UGk6qYfEBbY/HZVQ9j89w8YtYtq8RzAIrYjkHK5NML25O/w6W4f+I7GKI+88i3oF0F7XVMO8JMHOlwwfUg2REOQ+OnNbPJHuQxEZVy/QOksa503kG9mvulM+w/0+KMJzUPNBGoq5GieGkgDt4qP9HEV48Y8ZpbFBXtYfmaIXlD2L2EnnHs6UHKVvgfUXpkIO9zHHtQJF8JLN6kArFuEkrUyKH2zuNvB+ErQtfHk2Tw5NfItwiieTrJFMCpcl+wfXPinD9blDzdEVb5fW7wSHTouJv4MXTOuN+guCnVbNPA4ThH2vvMIfCXyZ1br/+A3kRw0yMEwAA"
        /></Footer>{/* END_HRIS_BENEFIT_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_benefits
      parameters:
        - name: created_after
          in: query
          description: If provided, will only return objects created after this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          description: If provided, will only return objects created before this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          description: The pagination cursor value.
          required: false
          schema:
            type: string
        - name: employee_id
          in: query
          description: If provided, will return the benefits associated with the employee.
          required: false
          schema:
            type: string
        - name: expand
          in: query
          description: >-
            Which relations should be returned in expanded form. Multiple relation names should be comma separated
            without spaces.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BenefitsGetParametersExpandSchemaItems'
        - name: include_deleted_data
          in: query
          description: >-
            Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion
            detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn
            more](https://docs.merge.dev/integrations/hris/supported-features/).
          required: false
          schema:
            type: boolean
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: modified_after
          in: query
          description: If provided, only objects synced by Merge after this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: modified_before
          in: query
          description: If provided, only objects synced by Merge before this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: page_size
          in: query
          description: Number of results to return per page. The maximum limit is 100.
          required: false
          schema:
            type: integer
        - name: remote_id
          in: query
          description: The API provider's ID for the given object.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBenefitList'
  /hris/v1/benefits/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: >-
        Returns a `Benefit` object with the given `id`.{/* BEGIN_HRIS_BENEFIT_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA91X8W/aOBj9V5B/RIEcZdyuSNMETQvtRsgxeltvqqwP5yMYHDs4TmmY9r+fQtIq3LpJuwaq3W+J833Pznsvz84XwsBgoHRKumSheUwsEiofBemSPkqcc0MsAhF3IcSihN6dEIvESRQpbdC/4Cj8eKhxTrrEDlEH2Egkn3P07azc5tJgoMFwJWP7sa0x3/URiwguV+j3GFOJND8CygsbkFf+6zZ7HGeLjSCOzUKrJFhMcJ1g/EPMbD0CQ5QGRMMHA3apv6FzgKfGspX7KNCg74ABBw2y7BWLuRbGRHHXthcoouZu3qaPdzZKG7ThTGBsd9qnJ69PO40CZTf7WxqIN636cj1Ts9d1GjBBIamPpuzenV5u3GXwyj17de9urzvudrV1l6vf6jSA+mg66oynN+2x02uNnyigH37/dPpX3+lfuXW2PW+7y5uNO2Wt0ZStZtvL9tWAba6Gf96725uTkXPddqfnnauBao3PJvHobKJGvWaTWKSsJOl+/lIeKAzSc7zaR6VXc6UZ1ly12W+7DCHAEj25IhDxRpTMBGfNuN2EELZKwiZuMhXaIfoc7J7j0UdY6qoN/bBOQGMzksGDEFzJRxVIl5y7w557du7sW6J3B1zATCDpGp3gNz4m3c9klhufRgIkNWmExCJMhRHIlDIljeazZDeJRTCMhEoRS5ffKdG0gM2GpE99MFlXpNUd91FTmfFnEY2hMpg9hf07GoFZZN+dAW3y7tusYJ1wjb4HGkI0qLMXuP1qPSmNMKih5kGqlRAV6bLDLMSg71WgjqcICEaZ8svc73N7QC77EM6UGk6qYfEBbY/HZVQ9j89w8YtYtq8RzAIrYjkHK5NML25O/w6W4f+I7GKI+88i3oF0F7XVMO8JMHOlwwfUg2REOQ+OnNbPJHuQxEZVy/QOksa503kG9mvulM+w/0+KMJzUPNBGoq5GieGkgDt4qP9HEV48Y8ZpbFBXtYfmaIXlD2L2EnnHs6UHKVvgfUXpkIO9zHHtQJF8JLN6kArFuEkrUyKH2zuNvB+ErQtfHk2Tw5NfItwiieTrJFMCpcl+wfXPinD9blDzdEVb5fW7wSHTouJv4MXTOuN+guCnVbNPA4ThH2vvMIfCXyZ1br/+A3kRw0yMEwAA"
        /></Footer>{/* END_HRIS_BENEFIT_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_benefits
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: >-
            Which relations should be returned in expanded form. Multiple relation names should be comma separated
            without spaces.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BenefitsIdGetParametersExpandSchemaItems'
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Benefit'
  /hris/v1/companies:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `Company` objects.{/* BEGIN_HRIS_COMPANY_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+WbbXPaOBCA/wrjjxleSmiuDTM3NwRCgAbHB+Su6U3HI+TFCGTJkeUQ0+l/v/ELJLn2OkNvwcT3KcE2j+zHu9JKNl8MSjS4UkVG05grFhhlw5MOcKNptKXnExEZZYP4zCQeZIfYD6dG2QhC35dKg9NlwJ2gp2BmNI2aB8qFSijYjIFTiw+vMaHBVUQzKYLa9muVWfI9o2xwJpbgtCiVodA/AqUHVkh65D8+xrsDbZQNnwSBnisZuvMR3IcQ/JAZnw8HD4QmvOIQTWrPvl9RKeB72+Izd4CDBqdDNOmABhpfYtbWXGs/aNZqc+B+NWm36sBDDUSNKM0oh6B21jg/fXd+VskoSeu/2S7/tX6yuJ/K6bsT26XcJuHJcEIfzUl/ZS7ct2b77aO5vj0z18u1uVi+ObFdcjKcDM9uJneNm06rfvOdA+zxLx/P/7joXAzME7q+bJiLu5U5ofXhhC6n635jcEVXg97vj+b67nTYuW2Yk8uzwZWs37RHwbA9ksNWtWqUjed30mj+9eX5hixA3gVzNkvkPNvX94gLz6Sk94H4rOKHU85oNWhUiUfWUpBVUKXSq3ngMFKzONEzqbwMaltK+qB0ZJ/2n+BPWxvj+5AoeNrw9um/+tl7O0h2V33hbu4dk2J744ymcWn2Wmb7svMyiloPhHEy5WA0tQrhm9A3mn8ZDgt8TiJbxBbKBng+lxFAEt7gEr7ZocCTGuz4Vr/8ZPtEz582Mcf4HH+4D5kCxyKKeKBBxW19/lr+nvhWxyr9KdVyJhWFkilXOLeg1bHsLdY25coe52Lx571wDYqULBIpyTmSlISZmbCvpStz0oESORcKiJ4DjpoM9tyN3b07/+QuvOrCz8sRsrE2rIkQUOqNcKRlvMrhOqgDdUrtOVGcIYVWBuuNjiTx9uBK96SPJyumneY06u3PU4eoFRNT+Ygjaos7YPahDGwdAI5bZsXE4sTJZdJKXNmXeqAkjqonaCWG5hsze5DWlaFKCAiuUtYRVd2767gCAYrR0rg7sXCkuCnRDmbaz9TY3qDx+KZ/exBFTAT7MRUGWuJ2Rwly44jFsCMytIfc6xHGIUIrKjcaU6zdGxWnl+qxqZwiW4qRezGEMtj3RiWLKC1A4Vx2b5ThXtTSB56g7ZJXu/oKPUKSRMaQlcJei6r/EGZ9EfigmI5KlgKPYUXbJsnYBl+4SUm8Hsk5w+q7t7iDx1xuo19/LPkDOMgBFyTQYtcNg9Dz21yGSO5iHI1xhUvSQRjolVRLpGFhi/sfDAwfQCyQy/sEmW+M7e7hOqSU4HhIUMVZE4//8AhHTcp6PWkVCnYfxtJA6PjZstpZnjdVSL1SgspzhfxAPdLNbMYoA6FxtG1xhRv1bpYJEsPRUm8eeh5Czx6VCLiWLhNIWjJaLpGz65VHgQaFNU1JaYe87m+L7P1FiUWiNvE1wYoTi0Q05R3Rmvh+vNE5ID2ey2AHH9Bym83FFyw93FI7ZRYxQalEXqLyE2aBu7Qu0+jBNWPFK5ssEnFJmUaa0mxxL96Mur7y6l1HHGec7SoMpM8B7elVRrNblEKwmdAcdW1lcSIcEiFnVwp93fW2pSRnBGuqtqHluT6wP1cjeJA81KU0AXCMZczX9uruiPk+Z8nJImaUyqi2Gr1/bEzNglbh45ZVGodJ59klVEus9aWXzBej2QX9KN3um+Neq/t5oRCkTSDGYsosagSytE2kCn2Ly6kbO5C1iWImII2UE8UE6EKLKsVvxmTZhCnNrhd7meH2w1XJwnor9vbDVb4z5gNKGwFxImxttguk9/7eKra++Hdk6BOkDFqchYdPwJFXaGLinl9t/Pdr/Pz1b3n6z1ZkPAAA"
        /></Footer>{/* END_HRIS_COMPANY_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_companies
      parameters:
        - name: created_after
          in: query
          description: If provided, will only return objects created after this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          description: If provided, will only return objects created before this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          description: The pagination cursor value.
          required: false
          schema:
            type: string
        - name: include_deleted_data
          in: query
          description: >-
            Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion
            detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn
            more](https://docs.merge.dev/integrations/hris/supported-features/).
          required: false
          schema:
            type: boolean
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: modified_after
          in: query
          description: If provided, only objects synced by Merge after this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: modified_before
          in: query
          description: If provided, only objects synced by Merge before this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: page_size
          in: query
          description: Number of results to return per page. The maximum limit is 100.
          required: false
          schema:
            type: integer
        - name: remote_id
          in: query
          description: The API provider's ID for the given object.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCompanyList'
  /hris/v1/companies/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: >-
        Returns a `Company` object with the given `id`.{/* BEGIN_HRIS_COMPANY_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+WbbXPaOBCA/wrjjxleSmiuDTM3NwRCgAbHB+Su6U3HI+TFCGTJkeUQ0+l/v/ELJLn2OkNvwcT3KcE2j+zHu9JKNl8MSjS4UkVG05grFhhlw5MOcKNptKXnExEZZYP4zCQeZIfYD6dG2QhC35dKg9NlwJ2gp2BmNI2aB8qFSijYjIFTiw+vMaHBVUQzKYLa9muVWfI9o2xwJpbgtCiVodA/AqUHVkh65D8+xrsDbZQNnwSBnisZuvMR3IcQ/JAZnw8HD4QmvOIQTWrPvl9RKeB72+Izd4CDBqdDNOmABhpfYtbWXGs/aNZqc+B+NWm36sBDDUSNKM0oh6B21jg/fXd+VskoSeu/2S7/tX6yuJ/K6bsT26XcJuHJcEIfzUl/ZS7ct2b77aO5vj0z18u1uVi+ObFdcjKcDM9uJneNm06rfvOdA+zxLx/P/7joXAzME7q+bJiLu5U5ofXhhC6n635jcEVXg97vj+b67nTYuW2Yk8uzwZWs37RHwbA9ksNWtWqUjed30mj+9eX5hixA3gVzNkvkPNvX94gLz6Sk94H4rOKHU85oNWhUiUfWUpBVUKXSq3ngMFKzONEzqbwMaltK+qB0ZJ/2n+BPWxvj+5AoeNrw9um/+tl7O0h2V33hbu4dk2J744ymcWn2Wmb7svMyiloPhHEy5WA0tQrhm9A3mn8ZDgt8TiJbxBbKBng+lxFAEt7gEr7ZocCTGuz4Vr/8ZPtEz582Mcf4HH+4D5kCxyKKeKBBxW19/lr+nvhWxyr9KdVyJhWFkilXOLeg1bHsLdY25coe52Lx571wDYqULBIpyTmSlISZmbCvpStz0oESORcKiJ4DjpoM9tyN3b07/+QuvOrCz8sRsrE2rIkQUOqNcKRlvMrhOqgDdUrtOVGcIYVWBuuNjiTx9uBK96SPJyumneY06u3PU4eoFRNT+Ygjaos7YPahDGwdAI5bZsXE4sTJZdJKXNmXeqAkjqonaCWG5hsze5DWlaFKCAiuUtYRVd2767gCAYrR0rg7sXCkuCnRDmbaz9TY3qDx+KZ/exBFTAT7MRUGWuJ2Rwly44jFsCMytIfc6xHGIUIrKjcaU6zdGxWnl+qxqZwiW4qRezGEMtj3RiWLKC1A4Vx2b5ThXtTSB56g7ZJXu/oKPUKSRMaQlcJei6r/EGZ9EfigmI5KlgKPYUXbJsnYBl+4SUm8Hsk5w+q7t7iDx1xuo19/LPkDOMgBFyTQYtcNg9Dz21yGSO5iHI1xhUvSQRjolVRLpGFhi/sfDAwfQCyQy/sEmW+M7e7hOqSU4HhIUMVZE4//8AhHTcp6PWkVCnYfxtJA6PjZstpZnjdVSL1SgspzhfxAPdLNbMYoA6FxtG1xhRv1bpYJEsPRUm8eeh5Czx6VCLiWLhNIWjJaLpGz65VHgQaFNU1JaYe87m+L7P1FiUWiNvE1wYoTi0Q05R3Rmvh+vNE5ID2ey2AHH9Bym83FFyw93FI7ZRYxQalEXqLyE2aBu7Qu0+jBNWPFK5ssEnFJmUaa0mxxL96Mur7y6l1HHGec7SoMpM8B7elVRrNblEKwmdAcdW1lcSIcEiFnVwp93fW2pSRnBGuqtqHluT6wP1cjeJA81KU0AXCMZczX9uruiPk+Z8nJImaUyqi2Gr1/bEzNglbh45ZVGodJ59klVEus9aWXzBej2QX9KN3um+Neq/t5oRCkTSDGYsosagSytE2kCn2Ly6kbO5C1iWImII2UE8UE6EKLKsVvxmTZhCnNrhd7meH2w1XJwnor9vbDVb4z5gNKGwFxImxttguk9/7eKra++Hdk6BOkDFqchYdPwJFXaGLinl9t/Pdr/Pz1b3n6z1ZkPAAA"
        /></Footer>{/* END_HRIS_COMPANY_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_companies
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
  /hris/v1/dependents:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `Dependent` objects.{/* BEGIN_HRIS_DEPENDENT_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA81UbW/aMBD+K5U/opCMUrY10jRRYNB2BEZhW1VV1hEficGxg+2UQtX/PoWXjm5dpbZI4+Od7x7fPffc3ZEQLEZKz4lPYs0NcUiiGArikzqmKBlKSxwCKQ8gwXUQvTkkDjFZmiptkX3hKJhpaRwRn3gJ6giLmeQjjszLwz0uLUYaLFfSeA9pxdEyjzhEcDlBVg1DlUn7HNAqsAiryD/M/NnkxaZgjI21yqK4h9MMzbOYeT0CE5QWRJGBBW8rv6hXAE/58soZCrTI6mChjhbDvMX1X7G1qfE9L0aRust/XYY3HkoPtOWhQONVyseHH44rxTXK8vfPNBKfSoXxdKiGHwo0CgWFrNDuh7dB/3QWjKOjoHZ0GywGlWAxWQTjybsCjaDQ7rcrnf5luVOvljpPBNCL9z+Pv5/UT86CQrholIPx5Szoh6V2P5wMF6fls2Y4O2t9uw0Wl4ft+qAc9BuVs6YqdWo90671VLvqusQh25Mk/tXdtmMtkBNIhkq1eo+jTxOIcIuV1SAg5cU0GwoeuqbsQgILJWFm3FAlXoKMg7dBoxfTDDTSrypS7jiNNtxzJR+IJz5pBK1qUGvUH6ugegNcwFAg8a3O8C/pEv+KMLBI1YgOubYxcQgmqVBzROKQEdfGUpm355Ao3wlNHBKrBKlQ4bK9vFlDjc3W+yLgd0bCGRO4sdJYSaQyS4ZLFI1ixWbM06WZKIs0F8Jji6awLGvt4ixfQCPJde6aZlwj64KGBC3qvJ/re+ep4dRhPlI6xN0MpyvAjpRONqhuKvdgMP8cxEu5fgW/rd5BF7SVq0LeznCrt4bbG/3vTL8vZHZw3jzoIbD5bogdnDepWVEaIbQ+Trv/VbxvkemrKf2h9ITBfLe3YA26H6cg3vMbfX3/C1P2ps6BCQAA"
        /></Footer>{/* END_HRIS_DEPENDENT_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_dependents
      parameters:
        - name: created_after
          in: query
          description: If provided, will only return objects created after this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          description: If provided, will only return objects created before this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          description: The pagination cursor value.
          required: false
          schema:
            type: string
        - name: employee_id
          in: query
          description: If provided, will only return dependents for this employee.
          required: false
          schema:
            type: string
        - name: include_deleted_data
          in: query
          description: >-
            Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion
            detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn
            more](https://docs.merge.dev/integrations/hris/supported-features/).
          required: false
          schema:
            type: boolean
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_sensitive_fields
          in: query
          description: Whether to include sensitive fields (such as social security numbers) in the response.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: modified_after
          in: query
          description: If provided, only objects synced by Merge after this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: modified_before
          in: query
          description: If provided, only objects synced by Merge before this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: page_size
          in: query
          description: Number of results to return per page. The maximum limit is 100.
          required: false
          schema:
            type: integer
        - name: remote_id
          in: query
          description: The API provider's ID

# --- truncated at 32 KB (359 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/openapi/merge-hris-api-openapi.yaml
Merge HRIS API

Documentation

Specifications

Examples

Schemas & Data

Other Resources

OpenAPI Specification
