openapi: 3.2.0
info:
  title: Deputy Hr API
  version: '1.0'
  description: 'Operations tagged Hr across 2 of this provider''s published API definitions: deputy-v2-api-openapi.yml, deputy-v2-scoped-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.{region}.deputy.com/api
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
      description: Your Deputy tenant subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
      description: 'Deputy region: au, eu, na, or deputy (AU default)'
security:
- ApiToken: []
tags:
- name: Hr
paths:
  /hr/v2/employees/{employeeId}/onboarding/{actionName}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
          description: Your Deputy tenant subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
          description: 'Deputy region: au, eu, na, or deputy (AU default)'
    put:
      operationId: HrOnboardingActionV2Controller_perform
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HrOnboardingActionHrOnboardingActionResponse'
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: actionName
        in: path
        required: true
        schema:
          type: string
      tags:
      - Hr
      security:
      - APIToken: []
      summary: Perform
      description: Perform.
  /hr/v2/employees/{employeeId}/onboarding/export:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
          description: Your Deputy tenant subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
          description: 'Deputy region: au, eu, na, or deputy (AU default)'
    get:
      operationId: HrExportV2Controller_exportHrData
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HrExportExportHrDataResponse'
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Hr
      security:
      - OAuth2ScopedAuthenticator: []
      summary: Export HR data
      description: Export HR data.
  /hr/v2/employees/{employeeId}/pay-details/export:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
          description: Your Deputy tenant subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
          description: 'Deputy region: au, eu, na, or deputy (AU default)'
    get:
      operationId: HrExportV2Controller_exportHrPayDetailsData
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HrExportExportHrPayDetailsDataResponse'
      parameters:
      - name: employeeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Hr
      security:
      - OAuth2ScopedAuthenticator: []
      summary: Export HR pay details data
      description: Export HR pay details data.
  /hr/v2/onboarding/bulk-export:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
          description: Your Deputy tenant subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
          description: 'Deputy region: au, eu, na, or deputy (AU default)'
    get:
      operationId: HrExportV2Controller_exportHrBulkData
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HrExportExportHrBulkDataResponse'
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: cursor
        in: query
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - Hr
      security:
      - OAuth2ScopedAuthenticator: []
      summary: Export HR bulk data
      description: Export HR bulk data.
components:
  schemas:
    HrOnboardingActionHrOnboardingActionResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    HrExportExportHrBulkDataResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            type: object
        cursor:
          type: integer
          format: int32
    HrExportExportHrDataResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
    HrExportExportHrPayDetailsDataResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: OAuth
x-refined-from:
- deputy-v2-api-openapi.yml
- deputy-v2-scoped-api-openapi.yml
x-provenance:
  method: searched
  source: https://developer.deputy.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.deputy.com/reference/addalocation.md
  - https://developer.deputy.com/reference/addalocationagainstanemployee.md
  - https://developer.deputy.com/reference/addanemployee.md
  - https://developer.deputy.com/reference/addasaletosalesmetrics.md
  - https://developer.deputy.com/reference/addawebhookurl.md
  - https://developer.deputy.com/reference/addleaveforaemployee.md
  - https://developer.deputy.com/reference/addnewworkplace.md
  - https://developer.deputy.com/reference/addunavailabilitydetailsforaemployee.md
  - https://developer.deputy.com/reference/archivealocation.md
  - https://developer.deputy.com/reference/copyaroster.md
  - https://developer.deputy.com/reference/create-a-memo.md
  - https://developer.deputy.com/reference/createadepartment.md
  - https://developer.deputy.com/reference/createmultipledepartments.md
  - https://developer.deputy.com/reference/deletealocation.md
  - https://developer.deputy.com/reference/deleteanemployeesaccountindeputy.md
  - https://developer.deputy.com/reference/deleteasingleoperationalunit.md
  - https://developer.deputy.com/reference/discardaroster.md
  - https://developer.deputy.com/reference/doatask.md
  - https://developer.deputy.com/reference/example-searchforemployeesfromalocation.md
  - https://developer.deputy.com/reference/findanemployeesleave.md
  - https://developer.deputy.com/reference/findoutanemployeesstatus.md
  - https://developer.deputy.com/reference/getagreedhoursbyemployeeid.md
  - https://developer.deputy.com/reference/getalistofrostersfromlast12hoursandforward36hours.md
  - https://developer.deputy.com/reference/getalocationssettings.md
  - https://developer.deputy.com/reference/getawardslibrarylist.md
  - https://developer.deputy.com/reference/getdetailsforaemployeebyid.md
  - https://developer.deputy.com/reference/getdetailsforallemployees.md
  - https://developer.deputy.com/reference/getlocationbyid.md
  - https://developer.deputy.com/reference/getlocations.md
  - https://developer.deputy.com/reference/getmyindividualtimesheet.md
  - https://developer.deputy.com/reference/getmynewsfeed.md
  - https://developer.deputy.com/reference/getmynotifications.md
  - https://developer.deputy.com/reference/getmysubordinatecontactdetails.md
  - https://developer.deputy.com/reference/getmytasks.md
  - https://developer.deputy.com/reference/getmytimesheets.md
  - https://developer.deputy.com/reference/getmytraining.md
  - https://developer.deputy.com/reference/getoperationalunits.md
  - https://developer.deputy.com/reference/getrostersavailableforswap.md
  - https://developer.deputy.com/reference/getsimplifiedlocationlist.md
  - https://developer.deputy.com/reference/getsuggestionsforrosterbyid.md
  - https://developer.deputy.com/reference/getunavailabilitydetailsforaemployee.md
  - https://developer.deputy.com/reference/inviteemployeetodeputy.md
  - https://developer.deputy.com/reference/modifysettingsinalllocations.md
  - https://developer.deputy.com/reference/modifysettingsinasinglelocation.md
  - https://developer.deputy.com/reference/myaddressonfile.md
  - https://developer.deputy.com/reference/myaddressonfileincludingemergency.md
  - https://developer.deputy.com/reference/myleaverequests.md
  - https://developer.deputy.com/reference/pauseorunpauseemployeestimesheettakeabreakfinishbreak.md
  - https://developer.deputy.com/reference/postajournal.md
  - https://developer.deputy.com/reference/publisharoster.md
  - https://developer.deputy.com/reference/re-activateaterminatedemployee.md
  - https://developer.deputy.com/reference/removealocationfromanemployee.md
  - https://developer.deputy.com/reference/retrievecurrentsystemtime.md
  - https://developer.deputy.com/reference/retrievecurrentsystemtimeofalocation.md
  - https://developer.deputy.com/reference/retrievesalesdata.md
  - https://developer.deputy.com/reference/setawardforemployee.md
  - https://developer.deputy.com/reference/startanemployeestimesheetclockon.md
  - https://developer.deputy.com/reference/stopanemployeestimesheetclockoff.md
  - https://developer.deputy.com/reference/terminateanemployee.md
  - https://developer.deputy.com/reference/updatealocation.md
  - https://developer.deputy.com/reference/updateanexistingemployee.md
  - https://developer.deputy.com/reference/updateasingleoperationalunit.md
  - https://developer.deputy.com/reference/updatemyaddress.md
  - https://developer.deputy.com/reference/viewatimesheetbyid.md
  - https://developer.deputy.com/reference/whatlocationscaniworkin.md
  - https://developer.deputy.com/reference/whenaminextworking.md
  - https://developer.deputy.com/reference/whenamiunavailable.md
  - https://developer.deputy.com/reference/wherecaniworkwhatdoido.md
  - https://developer.deputy.com/reference/whodoiworkwith.md
  merge:
    pages: 69
    deduped: 70
    conflicts_kept_first: 0